logo标签列表

我该如何将Java API文档添加到Eclipse中？

javaeclipsejavadoc
64
我已经从http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs下载了Java API文档，并使用以下方法将其附加到Eclipse中：

Window->Preferences->Java->Installed JREs->Edit->"选择rt.jar"->Javadoc Location

该位置已被接受且"验证"通过。但是，我无论如何都无法让Eclipse在我悬停在项目上时（例如在ArrayList声明中）显示Javadocs。我还尝试重新启动Eclipse以使其工作。

我做错了什么？

1
啊，当时没有意识到这一点，因为我正在开发一款Android应用程序，所以似乎没有使用JRE jar文件，而是使用了一个Android jar文件 :-/ 我将Java API文档附加到此文件中，然后提示工作了。感谢您的帮助。 - Kurru
2
请按照此链接中的步骤操作，我已经成功实现了。 - Amr Lotfy
还需注意，当您在API中按下Java类的F3键时，它会尝试打开源代码而不是Javadoc。通常情况下，您不需要查看本地Java库的源代码，而可以将鼠标悬停在工具提示中的底部图标上，并单击指向“在浏览器中打开附加的Javadoc”的链接。如果您按照以下答案中的说明操作，它将加载您的本地Javadoc。 - JesseBoyd
对于JDK 10，您可以按照以下步骤进行操作：https://stackoverflow.com/questions/51952111/how-can-i-view-java-10-javadocs-in-eclipse/52881855#52881855 - Amir
14个回答
107

在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），并点击编辑。
  • 使用Control+A选择所有的"JRE系统库"。
  • 点击"Javadoc位置"
  • 将"Javadoc位置路径："从"http://download.oracle.com/javase/6/docs/api/"更改为"file:/E:/Java/docs/api/"。

    • 对我而言，它必须像对我一样工作。 我不再需要互联网连接来查看Eclipse中的Java API文档。

    1
    仍然不起作用...注意：此元素没有附加源，并且在附加的Javadoc中找不到。 - Ahmed Hamdy
    1
    @AhmedHamdy 确保你指向 ../docs/api 而不仅仅是 /docs（我第一次就犯了这个错误） - Sudip Bhandari
    57

    使用ZIP文件进行离线Javadoc，而不是提取它。

    为什么要这样做？

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

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

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

    所以这种方法节省了大约200MB。

    如何使用apidocs.zip？

    1.打开 Windows -> 首选项

    enter image description here

    2.从已安装的JRE中选择jre，然后点击编辑...

    enter image description here

    3.从JRE系统库选择所有.jar文件，然后单击文档位置...

    enter image description here

    4.浏览apidocs.zip文件以获取归档路径并设置归档内路径如上所示。就是这样了。

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

    非常感谢！这正是我正在寻找的！ - Nicolas C.
    26

    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，您应该附加可在此处下载的源代码。

    我下载了那个jar文件，并将其作为所有jar文件的源附加，但是工具提示和javadoc查看器仍然没有显示详细信息。 - Kurru
    1
    您正在修改的 JRE 是默认的吗？此外，它是否是项目选择的 JRE（右键单击项目并转到首选项）？如果是，您可以在突出显示 JRE 类时按 F3 并调用源代码吗？ - LINEMAN78
    那还正确吗？我有一个当前的工作空间，没有附加源代码，只有Javadoc，并且它可以正常显示工具提示。 - kutschkem
    12

    虽然这个问题比较老，但我最近也遇到了同样的问题，所以我提供我的解决方案。 现在Java开发工具包（JDK）的源代码和API文档都在里面了。因此，解压你的JDK版本。你可以看到里面有一个 "src.zip" 文件，其中包含你需要的源代码和文档文件。 按照以下路径操作： Window->Preferences->Java->Installed JREs-> 选择你的JRE/JRD并按“编辑”键 选择所有.jar文件，并按“Source Attachment”按钮 选择 “External File...” 按钮并指向src.zip文件。 可能需要重启Eclipse（通常不需要）。 现在你应该能够看到JDK类的文档和源代码。

    我认为这个解决方案是正确的，因为我在JDK文件夹中没有看到任何“Javadoc”或“apidocs.zip”。src.zip不是Javadoc而是源代码，你的答案解决了我的问题，谢谢！ - Shukant Pal
    6
    我遇到了同样的问题，但我没有发现上面的一些答案有用，因为它们已经过时了，而新的JDK 1.8将文档部分移动到了JDK文件夹（C：\ Program Files \ Java \ jdk1.8.0_101）中的src.zip中。
    现在我尝试了上面的所有方法，但如果我在程序中按下Ctrl并单击（例如String或System），它仍然显示相同的问题“源未找到”。
    现在你可以这样做，进入JDK安装的文件夹（C：\ Program Files \ Java \ jdk1.8.0_101），尝试解压缩src.zip。在这里，您可能会遇到问题，因为由于此文件夹上的管理权限，它可能不允许您解压缩此src.zip。为解决此问题，请复制src.zip并粘贴到任何其他文件夹中（例如桌面），然后创建一个名为“src”的文件夹并在其中进行解压缩。现在将此文件夹复制回JDK 1.8文件夹（C：\ Program Files \ Java \ jdk1.8.0_101）。
    现在只需打开任何程序并按下Ctrl并单击任何外部对象或任何内容（例如String或System），然后单击“附加源”->“外部位置”->“外部文件夹”，并添加您的src位置（C：\ Program Files \ Java \ jdk1.8.0_101 \ src）。现在您可以愉快地使用了，我尝试过了，它对我有效。
    上述所有文件夹位置均来自我的系统，因此可能与您的不同。
    4

    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. 享受吧！

    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获得文档，但这需要稳定的互联网连接。
    1

    很可能是Javadoc位置指定的路径有问题。这个非常挑剔。确保它指向 javadoc 开始的根目录。它可能在你下载的压缩包中的几个目录下。

    位置可能是有效的。已找到文件“package-list”和“index.html”。 - Kurru
    尝试打开Javadoc视图，然后选择一个标准类或方法。 - Konstantin Komissarchik
    1
    不要附加JavaDoc文档，而是附加JDK src.zip源代码文件。

    enter image description here

    或者更好的是，将JRE主目录替换为JDK路径。 - cdxf
    1
    选择您想查看文档的类并按Ctrl +单击它，Javadoc页面将告诉您没有附加Javadoc文件，并在下面看到一个名为“附加文件”的按钮。点击该按钮并浏览到安装JDK的目录，通常对于Win是C：\ Program files \ Java \ jdk_xxx，此文件夹中有一个src.zip文件-选择它并按OK，所有操作都完成了-您已经附加了Javadoc。
    网页内容由stack overflow 提供, 点击上面的
    可以查看英文原文，
    原文链接