如何在IntelliJ IDEA中看到JavaDoc ?

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

enter image description here

317587 次浏览

使用View | 快速的文档或相应的键盘快捷键(Windows/Linux默认为Ctrl+, macOS默认为Ctrl+J,最新IDE版本为F1)。更多信息请参见文档

也可以在Settings | Editor | General | Code completion (Autopopup文档)中的显式的(通过快捷方式调用)上启用自动JavaDoc弹出窗口:

autopopup documentation

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

on mouse move

或者,您可以将光标定位在该项上并显示JavaDoc using

CTRL +

这是默认的快捷方式。

编辑:正如Methical提到的在Mac的快捷方式是

CTRL+j (+j不是+j)

有一个很好的功能,当你的鼠标在元素上显示快速文档。

IntelliJ 14

编辑器/通用->显示鼠标移动的快速文档

旧版本

把下面这行加到想法里。属性文件:

auto.show.quick.doc=true

转到File/SettingsEditor,单击General

向下滚动,然后,✔Show quick documentation on mouse move

enter image description here

为了最好地镜像eclipse功能,启用以下设置:

  • __abc0 -> __abc1
  • __abc0 -> __abc1

要在自动完成菜单中看到javadoc,请点击'。'来得到弹出窗口,然后将鼠标悬停在你正在处理的对象上,一旦你得到javadoc弹出窗口,你可以在弹出窗口中选择一个项目来切换javadoc。不理想……但这是有意义的。

另一个注意事项。选项菜单的搜索功能非常有用。只要输入“doc”,你就会看到doc的所有选项。

此外,搜索“autopopup doc”不仅会找到每个选项,而且还会在菜单中突出显示它们。32个赞!


<强>编辑: 超越最初的问题,这可能对那些只想快速方便地访问文档的人有用

在使用这个几天之后,它似乎只是习惯使用热键是最有效的方法。它会在你的文本输入标记所在的位置弹出任何文档,这样你就不必触摸鼠标了。这在智能感知弹出窗口工作以及将保持向上和向下导航。

就我个人而言,windows上的Ctrl+Q并不理想,所以我将其重新映射为Alt+D。重新映射可以在IDE设置/Keymap下完成。一旦进入键图菜单,只需搜索快速文档。

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

最接近Eclipse的将是Ctrl+Button2点击(滚动点击)

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

在我的例子中,只使用鼠标移动有点烦人,所以如果你在首选项/设置——> Keymap中搜索“快速文档”,你会发现:

  • Win-Linux:“Ctrl +问”和“Ctrl + Button2点击”(滚动点击)
  • Mac:“Ctrl + J”和“Ctrl + Button2点击”(滚动点击)

IntelliJ IDEA 15添加了这个特性

现在它以EAP的形式提供。

如下图所示,插入符号的位置不会影响光标的位置: enter image description here < / p >

这个特性IntelliJ IDEA 15 142.4675.3版本说明中实现。

对我来说,这不仅仅是打开javadoc窗口,还包括呈现完整的javadoc。如果您正在从Maven存储库导入库,并且没有告诉Idea在下载中包含javadoc,那么您仍然可能得到一个仅基于方法签名的稀疏javadoc。确保勾选“从Maven资源库下载库”对话框中的“JavaDocs”选项,该对话框可以在项目结构->项目设置->库下面找到。

我注意到选择方法名并按F2(快速文档)显示它是JavaDoc。 我使用Intellij 2016,和Eclipse Keymap

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

< >强Autopopup文档: IntelliJ IDEA祝辞Preferences祝辞Editor祝辞General祝辞Code Completion < / p >

enter image description here

关于鼠标移动的文档: IntelliJ IDEA祝辞Preferences祝辞Editor祝辞General < / p >

enter image description here

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