如何在IntelliJ IDEA中查看JavaDoc？

Question

我刚刚从Eclipse切换到IntelliJ。 IntelliJ缺少Eclipse的一个功能 - 当您将鼠标放在方法上时，Eclipse会显示javadoc信息。我认为显示它的方法是使用快捷方式 - 命令 + J ，但是当我点击它时，我会在下面的屏幕截图上出错。请告诉我如何快速获取javadoc信息。我至少需要知道方法返回的类型。

Answer 1

使用View | 快速文档或相应的键盘快捷键（默认情况下：Windows / Linux上的 Ctrl + Q 和 Ctrl + <在macOS上的kbd> J 或最近的IDE版本中的 F1 。有关详细信息，请参阅documentation。

还可以在Settings |中的显式（由快捷方式调用）代码完成时启用自动JavaDoc弹出窗口。 Editor | General | Code completion（ Autopopup文档）：

另一种查看快速文档的方法是鼠标移动：

Answer 2

在版本13.1 +中，有一个

的设置

转到File/Settings，IDE Settings / Editor，然后✔Show quick doc on mouse move。

版本14.0 +：

转到File/Settings，Editor，点击General。向下滚动，然后✔Show quick documentation on mouse move。

Answer 3

或者，您可以将光标放在项目上并使用

显示JavaDoc

  

CTRL + Q

这是默认的快捷方式。

编辑：正如Methical在Mac上提到的 ，快捷方式是

  

CTRL + j （ ^ + j 不⌘ + j ）

Answer 4

当鼠标悬停在元素上时，有一个很好的功能可以显示快速文档。

IntelliJ 14

编辑/一般 - ＆gt;显示有关鼠标移动的快速文档

旧版本

将以下行添加到idea.properties文件中：

auto.show.quick.doc=true

Answer 5

要最好地镜像日食功能，请启用以下设置：

• IDE设置/编辑器 - ＆gt; 其他。显示鼠标移动的快速文档
• IDE设置/编辑器/代码完成 - ＆gt; Autopopup文档

要在自动完成菜单中查看javadoc，请点击“。”获取弹出窗口，然后将鼠标悬停在您正在使用的对象上，一旦获得javadoc弹出窗口，您可以在弹出窗口中选择一个项目来切换javadoc。不理想......但它的东西。

另一个说明。选项菜单的搜索功能非常有用。只需输入'doc'，您就会看到doc的所有选项。

此外，搜索“autopopup doc”不仅会找到每个选项，还会在菜单中突出显示它们。太棒了！

---

修改 超越最初的问题，这可能对那些只想快速方便地访问文档的人有用。

使用它几天后，似乎习惯使用热键是最有效的方法。它将在文本输入标记所在位置弹出文档，以便您不必触摸鼠标。这也适用于intellisense弹出窗口，并在上下导航时保持不动。

就个人而言，Windows上的Ctrl + Q并不理想，所以我将其重新映射到Alt + D.可以在IDE Settings / Keymap下进行重新映射。进入键盘菜单后，只需搜索快速文档。

Answer 6

配置 IntelliJ IDEA CE 2016.3.4 以在鼠标悬停时启用JavaDocs。我在Mac OS上运行IntelliJ IDEA但认为Linux / Windows应该有类似的选项。

Autopopup文档： IntelliJ IDEA＆gt; Preferences＆gt; Editor＆gt; General＆gt; Code Completion

有关鼠标移动的文档： IntelliJ IDEA＆gt; Preferences＆gt; Editor＆gt; General

注意：请按应用按钮应用这些设置

Answer 7

转到设置 - ＆gt;编辑 - ＆gt;一般然后启用显示鼠标移动的快速文档

Answer 8

对我来说，不只是让javadoc窗口打开，而且还要提供完整的javadoc。如果从Maven存储库导入库并且不告诉Idea在下载中包含javadoc，您可能仍会获得仅基于方法签名的稀疏javadoc。一定要勾选“从Maven资源库下载库”对话框中的“JavaDocs”选项，该对话框可以在Project Structure - ＆gt;下找到。 Projtect设置 - ＆gt;库。

Answer 9

离Eclipse最近的地方是 Ctrl + Button2点击（滚动点击）

它在IntelliJ中被称为Quick Doc，我希望JetBrains的人有一天能像Eclipse一样添加快速的文档， Ctrl +鼠标移动它会好得多。

在我的情况下，只有鼠标移动才有点烦人，所以如果你搜索偏好设置/设置 - ＆gt;键盘地图用于＆＃34;快速文档＆＃34;你会发现：

• Win-Linux：＆＃34; Ctrl + Q ＆＃34;和＆＃34; Ctrl + Button2点击＆＃34; （滚动点击）
• Mac：＆＃34; Ctrl + J ＆＃34;和＆＃34; Ctrl + Button2点击＆＃34; （滚动点击）

Answer 10

我注意到选择方法名称并按F2（快速文档）显示它的JavaDoc。 我正在使用Intellij 2016和Eclipse Keymap