如何在IntelliJ IDEA中看到JavaDoc?

我只是从Eclipse切换到IntelliJ,并没有从Eclipse的function – 当你把鼠标放在一个方法,它显示一个javadoc信息。 我发现(可能是我错了)显示的方式是一个快捷键command + J 当我点击它时,我得到了一些错误,请看下面的屏幕截图。 请build议如何快速获取javadoc信息。 我至less需要知道什么types的方法返回。

在这里输入图像说明

使用View | 快速文档或相应的键盘快捷键(默认情况下:Windows / Linux上的Ctrl + Q和Mac上的Ctrl + J )。 有关更多信息,请参阅文档 。

也可以在Preferences |中启用显式 (通过快捷方式调用)代码完成的自动JavaDocpopup窗口 Editor | General | Code completionAutopopup文档 ):

autopopup文档

看到快速文档的另一种方式是鼠标移动

在鼠标移动

在13.1+版本中,有一个设置

转到File/SettingsIDE Settings / Editor ,然后✔ Show quick doc on mouse move

版本14.0+:

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

在这里输入图像说明

或者,您可以将光标定位在项目上并使用JavaDoc显示

CTRL + Q

这是默认的快捷方式。

编辑:由于Methical 在Mac上提到的快捷方式是

CTRL + j^ + j不是 + j

有一个很好的function,当鼠标移到元素上时显示快速文档。

IntelliJ 14

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

较旧的版本

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

 auto.show.quick.doc=true 

要最佳地反映月食function,请启用以下设置:

  • IDE设置/编辑器 – > Other.Show快速文档在鼠标移动
  • IDE设置/编辑器/代码完成 – > Autopopup文档

要在自动完成菜单中查看javadoc,请点击“。”。 获取popup窗口,然后将鼠标hover在正在使用的对象上,一旦获得了javadocpopup窗口,就可以在popup窗口中select一个项目来切换javadoc。 不理想…但它的东西。

作为另一个说明。 选项菜单的searchfunction非常有用。 只需input“文档”,你会看到所有的文档选项。

另外,search“autopopup doc”不仅会查找每个选项,还会在菜单中突出显示它们。 太棒了!


编辑:超出最初的问题,这可能是有用的,只是想快速,方便地访问文档。

使用了这几天后,似乎只是习惯了使用热键是最有效的方法。 它会popup文档的任何地方你的文本input标记的位置,所以你永远不必触摸鼠标。 这也适用于intellisensepopup窗口,并在上下导航时保持不变。

就个人而言,在Windows上Ctrl + Q不理想,所以我把它重新映射到Alt + D。 重新设置可以在IDE Settings / Keymap下完成。 一旦进入键盘菜单,只需search快速文档。

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

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

它在IntelliJ中被称为Quick Doc,我希望有一天JetBrains的用户可以使用Ctrl + Mouse来添加Eclipse这样的快速文档。

在我的情况下,只有鼠标移动有点烦人,所以如果你在首选项/设置 – >键盘映射 “快速文档”search,你会发现:

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

IntelliJ IDEA 15增加了这个function

现在它可以作为EAP使用。

如下图所示,插入位置不会影响光标位置: 在这里输入图像说明

IntelliJ IDEA 15 142.4675.3发行说明中实现了此function 。

对我来说,不只是让javadoc窗口打开,而且还要获得完整的javadoc。 如果您从Maven存储库导入库,并且不告诉Idea在下载中包含javadoc,那么您仍然可以获得仅基于方法签名的稀疏javadoc。 确保在“从Maven资源库下载库”对话框中勾选“JavaDocs”选项,该对话框可以在“项目结构” – >“项目设置” – >“库”下find。

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

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

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

在这里输入图像说明

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

在这里输入图像说明

注意:请点击应用button应用这些设置