如何生成JavaDoc文档

JavaDoc

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

参数信息

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

如何生成JavaDoc文档

命令行版：

1. 首先右键需要生成的项目，选择open in explorer打开目标文件夹。

2. 然后在文件资源管理器上方的文件路径前输入cmd （注意cmd后面需要加一个空格），以进入该目录的命令行。

3. 最后，在命令行内输入命令javadoc -encoding UTF-8 -charset UTF-8 Doc.java即可。（其中，-encoding UTF-8 -charset UTF-8）是文件路径存在中文，防止出现中文乱码而加上的

IDEA版：

1. 首先，点击IDEA上方的Tools-Generate JavaDoc。

2. 然后在弹出的窗口处填写你所需的信息即可。

   注：Generate JavaDoc Scope为你要生成的范围；Output directory中填写JavaDoc文档的生成路径；为防止出现中文乱码，需要分别在Locale和Other command line arguments中填入zh_CN,-encoding UTF-8 -charset UTF-8