【问题标题】：How do I add the Java API documentation to Eclipse?如何将 Java API 文档添加到 Eclipse？
【发布时间】：2011-06-03 18:21:25
【问题描述】：

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

将它附加到 Eclipse

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

并且该位置已被接受并且“验证”就好了。但是，就我的一生而言，当我将鼠标悬停在一个项目上时（例如在 ArrayList 的声明中），我无法让 Eclipse 在工具提示中显示 Javadocs。我还重新启动了 Eclipse 以使其正常工作

我做错了什么？

【问题讨论】：

啊。当时没有意识到这一点，因为我正在开发一个 Android 应用程序，所以我似乎没有使用 JRE jar 文件，而是使用 Android jar 文件：-/我将 java api doc 附加到这个文件和工具提示中开始工作。感谢您的帮助
按照this链接中的步骤操作，它对我有用。
还应该注意的是，当您从 API 对 Java 类按 F3 时，它将尝试打开源代码而不是 Javadoc，通常您不需要查看源代码本机 Java 库，并且可以将鼠标悬停并单击工具提示中的底部图标，该图标指示您“在浏览器中打开附加的 Javadoc”，如果您按照以下答案中的说明进行操作，这将加载您的本地 Javadoc。
对于 JDK 10，您可以按照以下步骤操作：stackoverflow.com/questions/51952111/…

标签： java eclipse javadoc

【解决方案1】：

对于 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 中获取了文档，但这需要稳定的互联网连接。

【讨论】：

【解决方案2】：

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

【讨论】：

【解决方案3】：

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

【讨论】：

或者更好，用JDK路径替换JRE home

【解决方案4】：

要在 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

在本地目录中提取 zip 文件。
从 eclipse Window --> Preferences --> Java --> "Installed JREs" 中选择可用的 JRE（例如 jre6：C:\Program Files (x86)\Java\jre6）并单击 Edit。
使用 Control+A 选择所有“JRE 系统库”。
点击“Javadoc 位置”
将“Javadoc 位置路径：”从“http://download.oracle.com/javase/6/docs/api/”更改为“文件：/E:/Java/docs/api/”。

它必须对我有用。我不再需要 Internet 连接来查看 Eclipse 中的 Java API 文档了。

【讨论】：

仍然无法正常工作... 注意：此元素没有附加源，在附加的 Javadoc 中找不到 Javadoc。
@AhmedHamdy 确保您指向 ../docs/api 而不仅仅是 /docs（我第一次这样做）

【解决方案5】：

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

现在我从上面尝试了所有方法，如果我在我的程序中按 ctrl 并单击（例如字符串或系统），它会显示相同的问题，我得到 Source not found。。 p>

现在你可以这样做了，去安装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 not found ，现在单击 Attach source -> External Location -> 外部文件夹并添加您的 src 位置（C:\Program Files\Java\jdk1.8.0_101\src）。现在你可以走了，我试过了，它对我有用。

以上所有文件夹位置均来自我的系统，所以对您来说可能会有所不同。

【讨论】：

【解决方案6】：

如果你使用的是 maven：

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

【讨论】：

【解决方案7】：

转到您的 JDK 安装。（C:\Program Files\Java\jdk1.8.0_66 我）。
解压src.zip文件（对我来说变成C:\Program Files\Java\jdk1.8.0_66\src\）。
在 Eclipse 编辑器窗口中：CTRL + Click 在 java.lang 库类上。（类似于String）。
Eclipse 会抱怨Source not found 并告诉你你没有源代码。
点击Attach source -> External Location -> External Folder。
找到你的源文件夹（我是C:\Program Files\Java\jdk1.8.0_66\src\）。
点击OK -> OK。
享受吧。

【讨论】：

【解决方案8】：

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

可能需要重新启动 Eclipse。（通常不会）现在您应该看到文档，以及来自 jdk 的类的源代码。

【讨论】：

我认为这可以正确解决问题，因为我在 JDK 文件夹中没有看到任何“Javadoc”或 apidocs.zip。 src.zip 不是 Javadoc，而是源代码 - 您的回答解决了我的问题，谢谢！

【解决方案9】：

我只需要自己挖掘这个问题并成功了。与其他人提供的解决方案相反，通往幸福结局的道路与 JavaDoc 直接相关。不需要“src.zip”文件。我在此过程中的考验和磨难涉及找到要指向的 CORRECT JavaDoc。将 Java 1.7 项目指向 Java 8 Javadoc 确实不工作。（即使“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/

瞧，悬停工具提示 javadoc 已重新启用。我希望这可以帮助其他试图解决这个问题的人。

【讨论】：

【解决方案10】：

用于从 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

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

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

4.浏览apidocs.zip文件Archive path并设置Path within archive如上所示。就是这样。

5.将光标放在任何类名或方法名上，然后按Shift + F2

【讨论】：

非常感谢！这正是我想要的！

【解决方案11】：

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

【讨论】：

你是对的！由于大多数 Java 默认安装在 Program Files 目录中。一种解决方案是将 javadocs 位置中的“Program Files”替换为“Progra~1”。

【解决方案12】：

确保选中“首选项”->“Java”->“编辑器”->“悬停”->“组合悬停”。

【讨论】：

【解决方案13】：

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。

【讨论】：

我下载了那个 jar 并将其作为所有这些 jar 的源附加，但工具提示和 javadoc 查看器仍然没有显示详细信息
你修改的JRE是默认的吗？还是为项目选择的 JRE（右键单击项目并转到首选项）？如果是这样，您可以在突出显示 JRE 类的同时按 F3 并调出源代码吗？
这仍然正确吗？我有一个当前工作区，没有附加源代码，只有 javadoc，它显示的工具提示很好。

【解决方案14】：

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

【讨论】：

它说：“位置可能有效。文件 'package-list' 和 'index.html' 已找到。
尝试打开 javadoc 视图，然后选择标准类或方法。