JavaDOC 文档注释（cmd生成&idea生成）

JavaDOC 文档注释

给Java类添加注释信息然后通过javadoc命令生成自己的api帮助文档

jdk api帮助文档

参数信息

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

/**
 * @author TRasdzz
 * @version 1.0
 * @date 2020/7/8 10:20
 *
 */
public class Doc {
    String name;

    /**
     * @author TRasdzz
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

    //可以通过命令行生成  javadoc 参数 java文件  javadoc -encoding UTF-8 -charset UTF-8 Doc.java

    //IDEA生成文档
}

用Idea生成JavaDoc文档

1. 选择是整个项目还是模块还是单个文件
2. 文档输出路径
3. Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
4. 传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

正在生成

成功了…

但目前还不会用这个帮助文档