如何使用Intellij Idea生成JavaDoc文档

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。在简略介绍JavaDoc写法之后，再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

代码示例:

/**
 * @author yang
 * @version 1.0
 * @since 1.8
 */
public class demo001 {
    /**
     * 99乘法表
     * @param args
     */
    public static void main(String[] args) {
        for (int i = 1; i <= 9; i++) {
            for (int j = 1; j <= i; j++) {
                System.out.print(j + "*" + i +"=" + (j*i)+ "  ");
                if (j==i){
                    System.out.println("  ");
                }
            }
        }
    }
}

注解的作用

首先规则：以//: 开始，以///:~结束。

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的jdk版本

当然还有一些其他注解，例如在类的方法上：

• @param 参数名

• @return 返回值情况

• @throws 异常抛出情况

IDEA如何配置生成javadoc文档

1. 点击idea tools工具栏
   

2. 设置一些参数
   

3. 控制台输出
   
   解释一下:第一个箭头,选择是整个项目还是模块还是单个文件;

第二个箭头,文档输出路径;

第三个箭头,Locale 选择地区，这个决定了文档的语言，中文就是zh_CN;

第四个箭头,传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
4. 生成的文件,打开index.html

5.成功!

原文链接