生成Javadoc文档

Javadoc文档

概念

JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。

官方文档

jdk8_javadoc

生成方法

//JavaDoc
// 是一种将注释生成HTML文档的技术，
// 生成的HTML文档类似于Java的API，易读且清晰明了。

   /**
    *  @author zxl
    * @version 1.0
    */
public class JavaDoc文档 {
    String name = "a";//实例变量

    /**
     * @author zxl
     * @since 1.8
     * @throws Exception 无异常抛出
     * @return 返回name姓名
     */
    public  String JavaDoc文档() throws Exception{
        return name;
    }

    //命令行：javadoc -encoding UTF-8 -charset UTF-8
    //IDEA:选中需要生成doc的文件，点击Tools，选择Generate JavaDoc
}

IDEA生成步骤

参考链接：IDEA生成Javadoc