Javadoc是什么

1、首先写java代码的都需要人手一份jdk帮助文档，比如jdk8的官网在线帮助文档：

 

https://docs.oracle.com/javase/8/docs/api/

它长这样：

 这就是javadoc输出的标准文档。

2、java中注释一共有三种：单行注释、多行注释和文档注释。

文档注释像这样：

/**
 * 该方法的描述
 * @param name 名称
 * @return 一个字符串
 */
public String getStr(String name){
   
    return  null;
}

而文档注释通过javadoc命令，可以生成html格式的类似上面的帮助文档。

直接通过命令 ： javadoc  xxx.java 就可以，不过为了支持java文件中的中文编码，你应该用：

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