JavaDos介绍

JavaDos介绍

JavaDos命令是用来生成自己的API文档的

参数信息：

• @author 作者号
• @version 版本号
• @since 指明需要最早使用的jdk版本
• param 参数名
• return 返回值情况
• throws 异常抛出情况

package operator;
/**
 * @author 作者名
 * @version 版本号
 * @since 指明需要最早使用的jdk版本
 * @return  返回值情况
 * @throws 异常抛出情况
 * @param  参数名
 */
public class Demo2 {
        //JavaDoc命令是用来自己生成API文档的
    String name;
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    //以上文档注释自己生成 只需要点击/**+enter
    public String test(String name) throws Exception{
        return name;
    }
}

打开自己Java文件的地址，可以在地址栏打开cmd进行操作：

//通过命令行 javadoc 参数 java文件

输入javadoc -encoding UTF-8 -charset UTF-8 java文件名

可能会出现的错误是

通过网上查找方法，发现：

• Linux下为UTF-8编码，javac编译gbk编码的java文件时，容易出现“错误: 编码UTF8的不可映射字符”解决方法是添加encoding 参数：javac -encoding gbk xxx.java

• Windows下为GBK编码，javac编译utf-8编码的java文件时，容易出现“错误: 编码GBK的不可映射字符”解决方法是添加encoding 参数：javac -encoding utf-8 xxx.java

修改之后，出现如此界面：

xxx.java文件夹中会出现大量其他文件，打开其中的index.html文件：

进入页面可查看程序的相关信息：

在idea上选择打开javadoc文档：

1. 打开工具中的生成javadoc选项：

2.为javadoc文档设置生成范围，输出目录，区域设置和其他参数等选项，即可完成