JavaDoc生成文档

这个和jdk帮助文档是一样的，主要就是用来生成自己的API文档的

public class JavaDocs {
    /**
     * @author qinpan
     *
     */

    /**
     *
     * @param age
     * @return
     */
    public static String name(String age){
        return age;
    }
}

这种@ 就是文档的参数信息一般有：

@author 作者名
@version 版本号
@since 指明需要最早使用的JDK版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

这写直接用 / ** */ 文档注释可以直接自动生成

生成JavaDoc 文档

用命令行生成

在目录里面输入cmd可以进入命令行，然后输入操作(在自己要生成文档的Java文件目录里面)

然后点击 index.html 就可以在浏览器中打开文档进行查看

用idea生成

找到TOOLs

然后点击 index.html 就可以在浏览器中打开文档进行查看

这就进入了自己的帮助文档了