JavaDoc文档注释

JavaDoc

• 文档注释

/**
 * @author huangjilin
 * @version 1.0
 * @since 1.8
 */                        //类注释

public class Doc {
    String name;

    /**
     * @author huangjilin
     * @param name
     * @return
     * @throws Exception
     */                     //方法注释

    public String test (String name) throws Exception{
        return name;
    }
}

• 通过/**/来给类或者方法加注释，加在类之上为类注释，加在方法之上为方法注释

生成Doc文档

• 找到.java文件所在的文件路径
• 通过文件路径前+cmd空格进入当前目录下的文件控制命令台
• 输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java（encoding为编码方式，charset为字符编码方式，再加上你想要生成Doc文档的.java文件）

• 等候加载跑完即可
• 之后在文件所在的文件路径中即可看见index.html（首页）点击打开即可!
  

下图为JavaDoc文档

利用IDEA生成JavaDoc文档

• 在IDEA顶部找到工具（Tools），选择生成JavaDoc文档（Generate JavaDoc...）
• 配置参数

1. 生成JavaDoc范围可以根据自己实际情况选择，可以选择当前.Java文件，也可选择整个项目
2. 输出目录自定义
3. 区域设置普遍为zh_CN（简体中文）
4. 其他命令行参数：编码格式和字符编码格式都设置为UTF-8（防止乱码）