JavaDoc生成文档的两种方法（命令行与IDEA生成JavaDoc文档）

JavaDoc生成文档的两种方法

	方法一：
	命令行：cd到java文件目录，输入命令：
	javadoc 参数 java文件名（其中参数主要是设置编码避免乱码），例如：
	javadoc -encoding UTF-8 -charset UTF-8 Doc.java
	方法二：
	打开 idea，点击 Tools-> Generate JavaDoc

例如写一个简单的java文件

/**
 * @author yuan
 * @version:1.0
 * @since 1.8
 */

public class Doc {
    String name;

    /**
     * @author yuan
     * @param s
     * @return
     */
    public String test(String s){
        return name;
    }
}

方法一：

在cmd中执行后

在java文件夹目录中可以看到

打开index.html可以看到以下页面,此文档与jdk的API文档差不多，由此可以发现自己的API文档成功生成

方法二：

打开 idea，点击 Tools-> Generate JavaDoc

此时可以在你选择的生成文档路径中看到新生成的许多文件，点击index.html就可以看到你自己生成的API文档了