生成JavaDoc文档

一、 使用JavaDoc命令生成JavaDoc文档

1. 准备需要生成JavaDoc文档的类：

/**
 * copyright(c)2021 zbh.ALL rights Reserved
 * <p>
 * 描述:测试生成JavaDoc文档
 *
 * @author zbh
 * @version 1.0
 */
public class HelloWorld {
    /**
     * 姓名
     */
    private String name;


    /**
     * 获取 姓名
     *
     * @return name 姓名
     */
    public String getName() {
        return this.name;
    }

    /**
     * 设置 姓名
     *
     * @param name 姓名
     */
    public void setName(String name) {
        this.name = name;
    }

    public static void main(String[] args) {
        System.out.println("hello word");
    }
}

2. 找到文件所在位置，在此处输入cmd，进入自己的Java路径：

3. 输入javadoc java文件名.java，回车：

4. 此时已经生成JavaDoc文档，到目录下看：

5. 点击index.html打开可以查看生成的JavaDoc文档：

注：若出现中文乱码情况，可以在第三步输入javadoc -encoding UTF-8 -charset UTF-8 java文件名.java：

二、IDEA生成JavaDoc文档

1. 准备需要生成JavaDoc文档的类

2. 在IDEA中依次点击tools----->GenerateJavaDoc

3. 出现如下界面：

• Generate JavaDoc scope：选择你需要生成JavaDoc文档的内容,我这里只需要将HelloWorld.java这个类生成文档。

• Output directory：生成的JavaDoc文档会存放在哪里。

• Other command line arguments：-encoding UTF-8 -charset UTF-8（这个防止中文乱码）

4. 点击ok后生成JavaDoc文档：