关于java:如何在IntelliJ IDEA中查看JavaDoc?

How to see JavaDoc in IntelliJ IDEA?

本问题已经有最佳答案,请猛点这里访问。

我刚从Eclipse切换到Intellij。Intellij缺少Eclipse的一个特性——当您将鼠标放在一个方法上时,Eclipse会显示javadoc信息。我认为显示它的方法是使用一个快捷方式-command+j,但是当我单击它时,我会遇到一些错误,如下面的屏幕截图。请告诉我如何快速获得JavaDoc信息。我至少需要知道一个方法返回什么类型。

enter image description here


使用View快速文档或相应的键盘快捷方式(默认情况下:Windows/Linux上的ctrl+q,MacOS上的ctrl+j,或最新的IDE版本中的f1)。有关详细信息,请参阅文档。

还可以在SettingsEditorGeneralCode completion中的显式(通过快捷方式调用)代码完成时启用自动javadoc弹出(autopopup文档):

autopopup documentation

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

氧化镁


在版本13.1+中有一个设置

File/SettingsIDE Settings / Editor,然后?Show quick doc on mouse move

版本14.0+:

转到File/SettingsEditor,单击General。那么向下滚动?江户十一〔11〕。

氧化镁


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

CTRL+Q

这是默认的快捷方式。

编辑:正如Mac上提到的,快捷方式是

CTRL+j (^+j not ?+j)


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

智能14

编辑器/常规->鼠标移动时显示快速文档

旧版本

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

1
auto.show.quick.doc=true

Intellij IDEA CE 2016.3.4的配置,以启用鼠标悬停时的JavaDocs。我正在Mac OS上运行Intellij思想,但我相信Linux/Windows应该有类似的选项。

自动选择文档:IntelliJ IDEA>Preferences>Editor>General>Code Completion

enter image description here

鼠标移动文档:IntelliJ IDEA>Preferences>Editor>General

氧化镁

注意:请按"应用"按钮应用这些设置


要获得最佳的镜像日食功能,请启用以下设置:

  • IDE设置/编辑器->其他。鼠标移动时显示快速文档
  • IDE设置/编辑器/代码完成->autopoup文档

要在"自动完成"菜单中查看JavaDoc,请单击"."以弹出窗口,然后将鼠标悬停在您正在使用的对象上,一旦获得JavaDoc弹出窗口,您可以在弹出窗口中选择一个项目以切换JavaDoc。不理想…但它是有意义的。

作为另一个注释。选项菜单的搜索功能非常有用。只需输入"doc",就可以看到doc的所有选项。

此外,搜索"autopoup doc"不仅可以找到每个选项,还可以在菜单中突出显示它们。太棒了!

编辑:除了最初的问题外,这对于那些只想快速方便地访问文档的人来说可能是有用的。

在使用了几天之后,似乎习惯了使用热键是最有效的方法。它将在文本输入标记所在的位置弹出任何内容的文档,因此您无需触摸鼠标。这也可以在IntelliSense弹出窗口中工作,并在上下导航时保持向上。

就个人而言,Windows上的ctrl+q并不理想,所以我将其重新映射到alt+d。可以在IDE设置/键映射下重新映射。进入keymap菜单后,只需搜索快速文档。


Intellij IDEA 15添加了此功能

现在它作为EAP提供。

如下图所示,插入符号位置不影响光标位置:氧化镁

此功能在Intellij IDEA 15 142.4675.3发行说明中实现。


转到"设置"->"编辑器"->"常规",然后启用"鼠标移动时显示快速文档"


对我来说,它不仅让JavaDoc窗口打开,而且让整个JavaDoc呈现出来。如果您从Maven存储库导入库,并且不告诉IDEA在下载中包含JavaDoc,那么您可能仍然会得到一个仅基于方法签名的稀疏JavaDoc。请确保在"从Maven存储库下载库"对话框中勾选"javadocs"选项,该对话框位于"项目结构"->"项目设置"->"库"下。


最接近Eclipse的是ctrl+button2 click(滚动单击)

它在Intellij中被称为QuickDoc,我希望有一天来自JetBrains的人能用ctrl+mouse添加像Eclipse这样的QuickDoc,这样会更好。

在我的例子中,只使用鼠标移动有点烦人,因此如果您在首选项/设置>键映射中搜索"快速文档",您会发现:

  • Win Linux:"ctrl+q"和"ctrl+button2 click"(滚动单击)
  • Mac:"ctrl+j"和"ctrl+button2 click"(滚动单击)

我注意到,选择方法名并按F2(快速文档)显示它是JavaDoc。我使用的是Intellij2016和Eclipse键映射