JavaDoc

Javadoc命令是用来生成自己API文档的

• 参数信息

1. @author 作者名

2. @version 版本名

3. @since 指明需要最早使用的jdk版本

4. @param 参数名

5. return 返回值情况

6. throws 异常抛出情况

/**
 * @author sunlight
 * @version 1.0
 * @since 1.8
 * */
public class Doc {
    String name;
​
    /**
     * @author sunlight
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}
​

 

以命令行生成JavaDoc文档

javadoc -encoding UTF-8 -charset UTF-8 Doc.java 

使用idea生成JavaDoc文档

1. 先新建一个文件 JavaDoc

2. 打开IDEA选择工具栏里Tools下的Generate JavaDoc

3. 在Output directory选择刚才新建的文件的地址

4. 在Other command line arguments栏当中输入-encoding UTF-8 -charset UTF-8

5. 点击确定就会在JavaDoc文件夹生成JavaDoc文档