如何在Eclipse中将包含javadoc/source的jar文件与其二进制文件进行关联?

82
我希望当我在eclipse中将鼠标悬停在类上时,能够显示jar文件中包含的javadoc注释。例如,在下载JODA-2.0后会得到三个jar文件: 在eclipse中,[右键项目 -> 属性 -> Java Build Path -> Libraries -> ADD JARs...] 将joda-time-2.0.jar二进制文件包含在项目中(可以引用这些类)。
但是,我如何链接其他两个jar文件中包含的源代码/ javadoc注释,以便当我悬停在这些类上时,我可以看到javadocs?
将另外两个jar文件(joda-time-2.0-javadoc.jar和joda-time-2.0-sources.jar)添加到构建路径中不会链接javadocs或源代码。
5个回答

72
  1. 右键单击项目 -> 构建路径 -> 配置构建路径
  2. 在新窗口中,转到“库”选项卡。
  3. 选择库并展开它。
  4. 有4个子选项。选择“Javadoc位置”并单击右侧的“编辑”按钮。
  5. 现在您可以添加一个包含文档的jar文件。这只是一个扩展名更改为jar的zip文件。确保在jar文件内部,index.html位于根目录中。您可以按“验证”按钮检查是否一切正常。

  1. 直接选择库,而不是Android私有库中列出的库(没有编辑功能)。
  2. 使用存档中的Javadoc,而不是URL。
- Gunnar Bernstein
只是补充一下,如果你正在使用一个常用的库,你可以附上一个指向在线API的链接,而不是一个硬编码的本地路径指向JAR文件。 - Sina Madani

67
您可以尝试在没有源附加的类上CTRL +单击(在编辑器中进行操作)。 当它向您显示一些关于该类的信息时,您将看到指导附加源对话框的按钮。 单击它,在弹出的对话框中选择类的源/ javadoc位置。
您还可以从项目构建路径设置中执行此操作:选择库选项卡,展开所需的库(jar),然后提供以下选项:源附件,javadoc附件,本地库位置等。 您只需选择所需内容并编辑其当前设置即可。
或者你可以像@JB Nizet所说的那样...

8
附加源代码和附加javadoc之间有什么区别? - Pacerier
@Pacerier source 包含程序源代码,而 javadoc 则包含解释程序功能的文档和注释。 - Stevoisiak
1
我收到了以下信息:“此类文件的JAR属于容器'Android Private libraries',不允许对其条目上的源附件进行修改。” - Radon8472

11

右键单击jar文件(其中包含类文件),选择“属性”,然后选择“Javadoc位置”,并选择带有javadoc的jar文件。同样地,对于源jar文件,使用“Java源代码附件”。


4
可能只有我一个人这样想,但是只有当Eclipse将文件识别为jar文件时,此方法才有效。就是说,文件旁边会显示一个小的jar图标。当我导入第三方jar文件时,它们会显示出似乎是文档图标的东西。从代码角度来看,它们可以正常工作,但右键属性时,我没有找到“javadoc位置”。 - Miguel Moll
如果你的jar包在WEB-INF/lib目录下,你不应该右键单击它们(正如你所说,它们会显示为文档),而是从“Web应用程序库”中的等效项中处理。 - xtian

9
你可以在Eclipse项目中的“.classpath”文件中编辑classpathentry。如果您想一次修改多个条目或生成路径,则这可能很有帮助。 例如: <classpathentry kind="var" path="HOME/3rdparty/junit.jar" sourcepath="/SOURCE/junit_src.zip"/>

+1个答案!我在考虑一种方法,可以一次添加多个JAR文件。 - Vikas Raturi
你不想直接编辑.classpath文件。它只应该被Eclipse使用,而不是手动编辑。@Mister Smith在这里实际上给出了真正正确的答案。尽管draganstankovic解释了一种至少可以完成工作的方法... - aaiezza
@scribaniwannabe:我知道这不是预期支持的方式,也不是最简单的方式,但对于我提到的用例,它可以更快速、无问题地工作。但是你必须小心使用有效的XML语法。 - Michael_S

0

最简单的方法是:

  1. 按下 control+(您想查看 Java 文档的单词)
  2. 会出现一个页面,上面有一个附加源代码的按钮。点击此按钮
  3. 选择外部位置。
  4. 浏览到 Java 文件夹的位置,然后选择您的 jdk。然后选择 src.zip。
  5. 按 OK。

问题已解决。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接