如何在IntelliJ IDEA中查看JDK的外部文档?

64

这个操作的快捷键是Shift+F1,但即使我已经将JDK的文档路径指向了docs文件夹(该文件夹从jdk-7u2-apidocs.zip解压而来),它总是灰色不可用。
谢谢

9个回答

107
你需要指定未打包文档的 docs/api 子目录,或使用 https://docs.oracle.com/javase/8/docs/api/ URL 来启用外部文档特性。
在 "文件 -> 项目结构..." 中,然后在这里: 进入图像描述

谢谢,它有效!此外,有没有办法使其以HTML格式显示文档? - JatSing
你是什么意思?它只是在默认浏览器中打开HTML页面。 - CrazyCoder
1
与浏览器中的HTML相比,它缺少一些图像和丰富的格式。 - JatSing
3
链接现在应该是https://docs.oracle.com/javase/8/docs/api/(请注意 'https' 和 '8')。我尝试编辑,但 SO 不允许我只更改两个字符:/ - MikeFHay
我正在寻找OpenJdk本地javadocs的位置。我无法访问开发人员系统以便访问任何http://路径。我应该在哪里找到javadocs? - edjm
显示剩余4条评论

16

我正在使用10.5.4版本。从文档或在线资源上看不清楚需要在 Project Structure > SDK's > (选择你的SDK) > Documentation Paths > Specify URL 添加这个。


6
您可以按照下面的步骤添加外部Javadocs API链接:

enter image description here


5

对于IntelliJ Idea: 调用“项目结构”(Ctrl+Shift+Alt+S),进入“平台设置 - SDKs”,选择右侧的“文档路径”选项卡,然后将JavaDoc的网址(http://docs.oracle.com/javase/7/docs/api/)添加到您的项目中。


3
在这里发布一下,以防你和我一样不想要javadocs,而是想要IDE内部的文档。
在我的情况下,我下载了OpenJDK 11,但无法在IntelliJ中获取文档。相反,我得到的是反编译的代码。
帮助我的是https://dev59.com/TloT5IYBdhLWcg3wlgTn#38413439中的答案。
1. 转到“文件”>“项目结构”>“SDK”>“源路径”,然后在右侧点击“+”。 2. 导航到您的JDK(我使用的是Ubuntu,所以它位于/usr/lib/jvm/openjdk-11/下)。 3. 选择src.zip(对我来说是/usr/lib/jvm/openjdk-11/lib/src.zip)。 4. 单击确定>确定(对于“选择根”弹出窗口)>确定(对于项目结构)
让Intellij进行索引,然后就可以在IDE中使用了。

2
我理解您的问题如下:
您想查看不在JDK中的类的javadocs。我有点不确定,因为CrazyCoder的回复是关于特定于JDK的javadocs的。
I am using Macos 10.8.4 and Intellij 11.1.5

我正在处理的项目是一个基于mvn的项目,有许多模块,它们之间存在复杂的依赖关系。
让我举个具体的例子来解释我做了什么,我相信其他人也可以重现:apache sshd。
我从maven中央下载了javadoc并将其存储在某个地方。在intellij中,我进入了模块设置(快捷键F4),然后在侧边栏中选择“库”。Maven会自动拉取所有依赖项,我可以在那里找到sshd。右侧显示类、源和JavaDocs。在我的情况下,JavaDocs部分有一个链接路径,指向我的本地m2目录。然而,该目录并没有包含javadoc jar文件。所以我想如何获取它:
mvn dependency:resolve -Dclassifier=javadoc

引用自这里

然而,由于我们的nexus中没有一些javadoc(我猜是这样,不确定),因此这种方法失败了。

所以我最终将手动下载的文件链接为javadoc链接,这样我就可以使用Shift + F1打开标准浏览器中的javadoc了。

也许其他人可以详细说明如何通过mvn完成此操作。 我没有时间进一步调查。


1

0
添加在线URL作为文档会导致文档弹出时出现延迟。我更喜欢从本地链接我的资源,以避免延迟。
你应该能够在jdk/lib/src.zip路径中找到"src.zip"文件。将该存档添加到你的文档路径中,一切都准备就绪。
如果使用其他JDK,你可以单独获取源代码,或者它可能已经捆绑在一起了。

Intellij JDK javadocs setup


0

其他答案已经很令人满意了,但如果您仍然无法看到文档,请确保您的Java文件位于src路径下。


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