JavaDOC

示例代码

/**
 * @author MMF
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author MMF
     * @param name 用户名
     * @return 用户名
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

}

使用CMD命令生成JavaDoc文档

找到项目路径，在该路径下使用以下命令Doc.java表示的是要生成文档的java文件

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

使用IDEA生成JavaDoc文档

1.打开需要生成文档的Java文件，点击Tools

2. 设置需要的参数

区域设置