威言大义

热度:

      在使用Java语言开发的过程中，开发人员经常需要用到一些开源的工具包。在使用别人的jar包的时候，为了保证正常调用包内的方法需要把jar包添加到Referenced Libraries中。由于jar中通常只打包了类的二进制文件，其JavaDoc文件仍需要以浏览器或chm帮助文档的方式查看。Eclipse开发环境中提供了将JavaDoc文档附加到jar包中的功能，使开发者不再需要人工查找类或方法的JavaDoc注释，省时又省力。

      Eclipse支持两种方式的JavaDoc导入：一种是在线的URL地址指向的JavaDoc页面，另一种是保存在本地的JavaDoc文档的jar包或zip包。给jar包附加JavaDoc的步骤如下：

      1. 在Eclipse的Package Explorer视图下Referenced Libraries下找到想导入JavaDoc的jar文件，右键->选择properties进入属性配置菜单。

      2. 在属性菜单中点击JavaDoc Location选项卡进入JavaDoc地址配置功能。

      3. 根据能获得的JavaDoc文档的具体情况，选择JavaDoc URL或JavaDoc in Archive中的任一个分别设置相应的JavaDoc地址。如果选择以JavaDoc URL方式导入，则在javadoc location path中填入JavaDoc的URL地址，如http://hc.apache.org/httpcomponents-client-4.0.1/httpclient/apidocs/(注意，不要在路径中指定index.html）;如果选择以JavaDoc in Archive的方式导入，则在javadoc location path中填入本地JavaDoc文件的路径（注意，在打包javadoc文件里要把index.html文件放在文件夹的顶层目录下。

      在导入了javadoc后，编写程序的过程中使用jar包中的方法时Eclipse会自动显示其注释说明，可以大大提高开发人员的效率。