Eclipse中javadoc文档的使用说明

目录

一、导出javadoc

1.1 配置生成

1.2 打包压缩 

二、使用javadoc

2.1 缺少javadoc

2.1 附加javadoc

---

在进行java项目开发的时候，我们经常会用到第三方jar包，但使用起来往往并不是那么顺畅，经常会在Eclipse和第三方API文档中反复切换。这种现象很常见，也很麻烦，毕竟我们对第三方jar包内的方法不是特别熟悉，需要查阅API文档方可知晓。

其实在Eclipse中，我们可以把API文档直接加载到对应的jar包中，这样在使用的时候就可以快速查阅。下面将分别讲述如何在Eclipse中生成javadoc文档，以及在Eclipse中为jar包添加对应的javadoc文档。

 

一、导出javadoc

在进行工程项目开发的时候，必须要对字符编码进行统一，这样可以避免乱码的出现，以及一些莫名其妙的映射问题。通常都是使用 “UTF-8无BOM” 编码格式。

 

1.1 配置生成

对于一份已经写好详细注释的java工程代码，我们在当前工程名上鼠标右击，会出现下拉选项栏，选择 “Export...”，如下图所示：

接下来在 “Export” 配置页面，选择 “Java -> Javadoc” 选项，然后点击 “Next”，如下图所示：

进入到 “Generate Javadoc” 配置页面后，根据当前系统环境配置好jdk中javadoc命令的绝对路径，同时选择好javadoc文档的输出目录，其它的参数采用默认值即可，然后点击 “Next”，如下图所示：

进入到 “Generate Javadoc” 第二张配置页面后，可以自定义javadoc文档的首页标题，其它的参数采用默认值即可，然后点击 “Next”，如下图所示：

</