一种是URL指向的JavaDoc页面,另一种是本地的JavaDoc文档的jar包或zip包。
一、.jre关联javadoc
1. Window->Pereferences...打开参数选择对话框,展开Java节点,单击“InstalledJREs",此时右边窗口会显示已经加载的jre。
2. 选中要设置的jre版本,单击"Edit",弹出JRE编辑窗口
3. 添加javadoc:将JREsystem libraries下的所有包选中,单击右边的“JavadocLocation”按钮,弹出javadoc设置窗口。选择“JavadocURL”单选框,单击“Browse”按钮,选中docs/api目录,然后点击“OK”
二、jar包关联javadoc
步骤如下:
- 在Eclipse的Package Explorer视图下Referenced Libraries下找到想导入JavaDoc的jar文件,右键->选择properties进入属性配置菜单。
- 在属性菜单中点击JavaDoc Location选项卡进入JavaDoc地址配置功能。
- 根据能获得的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会自动显示其注释说明
使用快捷键"Shift+F2",可快速调出选中类的api文档