Eclipse中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”，如下图所示：
在 “Generate Javadoc” 第三张配置页面中，必须要指定编码格式和字符格式为UTF-8，不然会出现字符映射的问题，导致无法生成javadoc文档，其它的参数采用默认值即可，然后点击 “Finish”，如下图所示：
在 “Update Javadoc Location” 确认页面中，点击 “Yes To All” 允许生成javadoc文档，并输出到指定位置，如下图所示：
此时可以发现，在 “Console” 窗口不断有javadoc文档的生成日志打印输出，如下图所示：
等到日志打印完毕，打开我们预先选定的输出文件目录，可以发现javadoc文档结构如下图所示：
使用浏览器打开index.html文件，基本上都显示正常，至此我们的javadoc文档已经生成成功啦，可以正常使用。但是页面标签名称貌似不对劲，如下图所示：
此时，以文本模式打开index.html文件，修改title标签，如下图所示：
重新载入页面，现在就变得很完美了。我们可以把这个javadoc文档外发给别人啦，最好压缩一下，打个包 ~ (^_−)☆
1.2 打包压缩
接下来，为了能在Eclipse中直接使用javadoc文档，需要对刚才生成的文件打包压缩，一定要在index.html文件所在目录全选然后打包，如下图所示：
生成 “xxxx.zip” 格式的压缩包，如下图所示：
二、使用javadoc
2.1 缺少javadoc
首先，没有为jar包配置对应的 javadoc文档，我们先看看实际的使用情况：
从上图中可以明显的看到，使用的方法是缺少注释信息的，这样的开发环境是很不友好的。
2.1 附加javadoc
在当前工程名上鼠标右击，会出现下拉选项栏，选择 “Build Path”，如下图所示：
继续选择 “Configure Build Path...”，如下图所示：
进入 “Java Build Path” 配置页面后，选择 “Libraries -> livehome_protocol-1.0.6.18.jar -> javadoc location:(None)”，然后点击 “Edit...”，如下图所示：
来到 “Javadoc For ‘livehome_protocol-1.0.6.18.jar’” 配置页面后，选择 “Javadoc in archive -> Workspace file”，然后点击 “Browse...” ，如下图所示：
在 “Javadoc Archive Selection Dialog” 配置页面中，选择相应的javadoc压缩文件，然后点击 “OK” ，如下图所示：
再次回到 “Javadoc For ‘livehome_protocol-1.0.6.18.jar’” 配置页面后，点击 “Validate...”，验证所选的压缩文件格式是否正确，如下图所示：
在 “Validating Javadoc Location” 确认栏中，点击 “OK” ，然后在 “Javadoc For ‘livehome_protocol-1.0.6.18.jar’” 配置页面中也选择 “OK”，如下图所示：
再次回到 “Java Build Path” 配置页面后，可以看到 “Javadoc location” 选项中已经显示了javadoc压缩文件的路径了，点击 “Apply and Close” 关闭配置页面。至此，javadoc文档已经配置成功啦~ ( ˘▽˘)っ
已经为jar包配置好了对应的 javadoc文档，我们再看看实际的使用情况：
从上图中可以明显的看到，光标选中的地方已经显示出了详细的注释信息。这样一来，开发人员可以快速的了解当前方法，而不用切换到API文档去搜索查阅。开发效率就是在这种不经意的细节中得到了有效地提升！