命令行、Idea生成JavaDoc

JavaDoc

javadoc是用来生成自己的API文档的。

参数信息

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

①通过命令行：编码-UTF-8 字符集-UTF-8（主要解决中文乱码问题）

​ javadoc -encoding UTF-8 -charset UTF-8

②使用IDEA生成JavaDOC文档

1）新建文件夹JavaDoc，用来存放生成的JavaDoc文档

2)【Tools】->【Generate JavaDoc…】

3)在弹出的界面，在【Ouput directory】，选择之前新建的文件夹。

Locale处，填写语言 zh_CN，中文；下一行设置编码 -encodinig utf-8 -charset utf-8

4）下述结果表明idea成功生成JavaDoc文档，可去之前新建的文件夹查看。

找到index.html，用浏览器打开

是一个可在线阅读自己代码的，类似官方提供的API文档的格式。