如何在Eclipse 中生成JavaDoc文档

  

  如何在Eclipse 开发工具中生成JavaDoc文档，在这里简要的记录以下，方便日后查阅。

1 选中需要生成JavaDoc文档的项目，单击右键---》Export--》Export，选择Java下的JavaDoc。

      具体如下图所示：

2 择生成文档的命令，我们选择jdk目录下的javadoc.exe。选择生成Javadoc文件的目标路径，默认为项目跟目录。

  

3 配置生成文件的详细选项。

  这一步可以选择要生成文件的具体配置信息，例如文档标题、文档的标签、是否将项目依赖的包也包含到项目链接中等。具体的配置信息根据自己的需求选择即可。

4 最后一步，配置生成文档的参数。

  这一步需要配置生成生成文档的参数，包括虚拟机参数设置、其它额外的命令参数、编译的jre版本等。这里需要注意的是如果项目的编码格式是UTF-8的话，可能生成的文档会有乱码或者报错“编码GBK的不可映射字符”。这是只需要在下面配置额外的命令参数“-encoding UTF-8 -charset UTF-8”即可。如下图所示：

  

5 成功生成文档。

 执行完上一步后文档成功生成。具体信息如下所示：