如何将Java API文档添加到Eclipse?

时间:2011-01-05 01:50:40

标签: java eclipse javadoc

我已经从http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs下载了Java API文档,并且据说使用

将它附加到Eclipse
  

窗口 - >首选项> Java的>安装   JREs->编辑 - >“选择rt.jar” - > Javadoc   位置

该位置已被接受,“验证”就好了。但是,对于我的生活,我不能让Eclipse在工具提示中显示Javadocs,当我将鼠标悬停在一个项目上时(例如在ArrayList的声明中)。我还重新启动了Eclipse以试图让它工作

我做错了什么?

14 个答案:

答案 0 :(得分:105)

要在Eclipse中使用脱机Java API文档,您需要先下载它。 Java文档的链接(最后更新于2013-10-21):

Java 6
页面:http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u25-doc-download-355137.html
直接:http://download.oracle.com/otn-pub/java/jdk/6u30-b12/jdk-6u30-apidocs.zip

Java 7
页面:http://www.oracle.com/technetwork/java/javase/documentation/java-se-7-doc-download-435117.html

Java 8
页面:http://www.oracle.com/technetwork/java/javase/documentation/jdk8-doc-downloads-2133158.html

Java 9
页:http://www.oracle.com/technetwork/java/javase/documentation/jdk9-doc-downloads-3850606.html

  1. 解压缩本地目录中的zip文件。
  2. 从eclipse Window --> Preferences --> Java --> "Installed JREs"中选择可用的JRE(例如jre6:C:\ Program Files(x86)\ Java \ jre6)并单击编辑。
  3. 使用 Control + A 选择所有“JRE系统库”。
  4. 点击“Javadoc位置”
  5. 将“Javadoc位置路径:”从“http://download.oracle.com/javase/6/docs/api/”更改为“file:/ E:/ Java / docs / api /".
  6. 它必须起作用,因为它对我有用。我不再需要Internet连接来查看Eclipse中的Java API文档了。

答案 1 :(得分:56)

对于zip文件中的脱机Javadoc而不是解压缩。

为什么采用这种方法?

这已经回答使用提取的zip数据,但它比简单的zip文件消耗更多的内存。

zip文件和提取数据的比较。

jdk-6u25-fcs-bin-b04-apidocs.zip  --->  ~57 MB
after extracting this zip file  --->  ~264 MB !

所以这种方法可以节省我的约。 200 MB。

如何使用apidocs.zip?

  

1.打开Windows -> Preferences

enter image description here

  

2.从jre选择Installed JREs,然后点击Edit...

enter image description here

  

3.从.jar中选择所有JRE system libraries个文件,然后点击Javadoc Location...

enter image description here

  

4.浏览apidocs.zip的{​​{1}}文件并设置Archive path,如上所示。就是这样。

     

5.将光标放在任何类名或方法名称上,然后点击 Shift + F2

答案 2 :(得分:25)

Eclipse不会从javadoc位置提取工具提示。如果你说在浏览器中打开,它只使用javadoc位置前置到链接,你需要下载并附加JDK的源代码才能获得工具提示。对于JRE下的所有JAR,您应该为javadoc位置提供以下内容:http://java.sun.com/javase/6/docs/api/。对于resources.jar,rt.jar,jsse.jar,jce.jar和charsets.jar,您应附加可用的源here

答案 3 :(得分:11)

老问题,但我目前遇到了这个问题。所以我为你提供了解决方案。 现在源和javadoc都在jdk中。所以,解压缩你的jdk版本。你可以看到contanins是一个“src.zip”文件。以下是您需要的源和doc文件。 按照路径: Window-> Preferences-> Java-> Installed JREs->选择你的jre / jrd然后按“编辑” 选择所有.jar文件,然后按Source Attachement。 选择“外部文件...”按钮,并将其指向src.zip文件。

Maibe需要重启Eclipse。 (通常不是) 现在你应该看到文档,以及来自jdk的类的源代码。

答案 4 :(得分:5)

我遇到了同样的问题而且我没有找到上述一些有用的答案,因为它们已经陈旧且使用新的JDK 1.8,文档部分已经有了 已移至JDK文件夹中的src.zip(C:\ Program Files \ Java \ jdk1.8.0_101)。

现在我尝试了上面的所有内容,如果我在程序中按ctrl并单击(例如字符串或系统),我会看到同样的问题我得到未找到来源

现在你可以这样做,转到安装了JDK (C:\ Program Files \ Java \ jdk1.8.0_101)的文件夹并尝试解压缩src.zip。在这里,您可能会遇到一个问题,因为有时由于此文件夹的管理权限,您无法解压缩此 src.zip 。要解决此问题,请复制src.zip并粘贴到任何其他文件夹(例如Desktop),然后创建一个文件夹src并在其中解压缩。 现在将此文件夹复制回JDK 1.8文件夹**(C:\ Program Files \ Java \ jdk1.8.0_101)。**

现在只需转到eclipse并打开任何程序并按下ctrl并单击任何外部对象或任何内容(例如字符串或系统)。您将找不到Source,现在单击Attach source - >外部位置 - > 外部文件夹并添加您的src位置(C:\ Program Files \ Java \ jdk1.8.0_101 \ src)。 现在你很高兴,我试过,它对我有用。

以上所有文件夹位置都来自我的系统,因此您可能会有所不同。

答案 5 :(得分:3)

  1. 转到JDK安装。 (C:\Program Files\Java\jdk1.8.0_66对我来说。)

  2. 解压缩src.zip文件(对我而言变为C:\Program Files\Java\jdk1.8.0_66\src\。)

  3. 在Eclipse编辑器窗口中:CTRL + Click库类上的java.lang。 (类似于String)。

  4. Eclipse会抱怨Source not found并告诉您没有来源。

  5. 点击Attach source - > External Location - > External Folder

  6. 找我的源文件夹(C:\Program Files\Java\jdk1.8.0_66\src\)。

  7. 点击OK - > OK

  8. 享受。

答案 6 :(得分:1)

您在Javadoc Location中指定的路径可能存在问题。这很挑剔。确保它指向javadoc开始的根目录。它可能是您下载的zip中的一些目录。

答案 7 :(得分:1)

我遇到了类似的问题,看起来罪魁祸首是存档路径中的空间(例如,C:\ Program Files \ java \ jdk)。将存档移动到路径中没有空格的另一个目录后,它开始工作。

答案 8 :(得分:1)

选择一个要查看其文档的类,然后按住Ctrl键并单击它,Javadoc页面将通知您没有附加Javadoc文件,并且下面会看到一个名为“附加文件”的按钮。按下该按钮并浏览到安装JDK的目录,通常对于Win是C:\ Program files \ Java \ jdk_xxx,在这个文件夹中有一个src.zip文件 - 将它打开并按OK然后完成所有操作 - 你已经完成了有Javadoc附件。

答案 9 :(得分:0)

确保“偏好设置” - > “Java” - > “编辑” - > “悬停” - >选中“合并悬停”。

答案 10 :(得分:0)

我只需要自己挖掘这个问题并成功。与其他人提供的解决方案相反,我快乐结局的路径与JavaDoc直接相关。不需要“src.zip”文件。我在此过程中的尝试和磨难涉及找到 CORRECT JavaDoc指向。在Java 8 Javadoc上指向Java 1.7项目 NOT 工作。 (即使“jre8”似乎是唯一可用的安装的 JRE。)因此,我不必要地将头撞在砖墙上。

窗口>偏好> Java>已安装的JRE

如果没有列出项目的JRE(就像我将jre7项目迁移到新的jre8工作区时那样),您需要在此处添加它。单击“添加...”并将工作区指向所需的jre文件夹。 (我的是C:// Program Files / Java / jre7)。然后“编辑...”现在可用的JRE,选择rt.jar,然后单击“Javadoc Location ...”并将其瞄准正确的javadoc位置。供我使用:

对于jre7 - http://docs.oracle.com/javase/7/docs/api/ 对于jre8 - http://docs.oracle.com/javase/8/docs/api/

Voila,hover tooltip javadoc重新启用。我希望这有助于其他任何人试图解决这个问题。

答案 11 :(得分:0)

如果你正在使用maven:

mvn eclipse:eclipse -DdownloadSources=true  -DdownloadJavadocs=true

答案 12 :(得分:0)

  

而不是附加JavaDoc附加JDK src.zip

enter image description here

答案 13 :(得分:0)

对于Linux上的OpenJDK 8,请参见:https://askubuntu.com/questions/755853/how-to-install-jdk-sources

对我有用的方法是:

  • 默认src.zip是指向不存在的文件夹的符号链接...
  • sudo apt-get install openjdk-8-source这将添加此文件夹
  • locate "src.zip"
  • Eclipse:Window --> Preferences --> Java --> "Installed JREs",编辑并指向src.zip(或打开任何JRE类,例如HashMap并附加源代码)

通过Ctrl + Shift + t打开JRE类时,您现在应该看到JavaDoc,以前这是不可能的,Eclipse可能会通过鼠标悬停方法的默认URL获取文档,但这需要稳定的Internet连接。