【问题标题】:How to see JavaDoc in IntelliJ IDEA? [duplicate]如何在 IntelliJ IDEA 中查看 JavaDoc? [复制]
【发布时间】:2012-06-18 16:04:02
【问题描述】:

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

【问题讨论】:

    标签: java intellij-idea ide javadoc


    【解决方案1】:

    使用View | 快速文档或相应的键盘快捷键(默认情况下:Windows/Linux 上为 Ctrl+QCtrl+J 或最新 IDE 版本中的 F1)。请参阅documentation 了解更多信息。

    还可以在Settings 中的显式(由快捷方式调用)代码完成上启用自动JavaDoc 弹出窗口| | Editor | General | Code completion自动弹出文档):

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

    【讨论】:

    • +1,在 IntelliJ Idea CE for Android 中找不到 Preferences
    • Win7 = 将光标定位在类之前 -> CTRL+q
    • 我傻到在 Mac 上遵循上述建议。命令+q。繁荣!退出 IntelliJ。天才..
    • Mac 上是 CTRL+J。
    • 当我为 String.compareToIgnoreCase() 执行此操作时,我只看到签名,而不是结果的解释。我是否需要更改设置以获取完整的 JavaDoc?
    【解决方案2】:

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

    显示 JavaDoc

    CTRL+Q

    这是默认快捷方式。

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

    CTRL+j^+j 不是 +j)

    【讨论】:

    • 这就像 eclipse 如何拉起文档,而不是最高投票的答案。谢谢!
    • 在 Mac F1 中的作用等于 Ctrl + J 来显示 JavaDoc
    • @jfuentes 因为我们在 Macbook 键盘上默认没有 F1 ^ + J 有效
    【解决方案3】:

    转到File/SettingsEditor,点击General

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

    【讨论】:

    • OK 有了这个技巧,我们有了与 Eclipse 完全相同的相同行为(鼠标悬停)
    • 自 v13.0 起添加的功能。见jetbrains.com/idea/webhelp/editor.html
    • 在 Mac 上,将 File/Settings 替换为 IntelliJ/Preferences
    • 但是从 14.0 开始,这个功能很糟糕。有时它们会干扰您点击事物的能力,或者被卡住并且永远不会消失。
    • 您不必展开“编辑器”菜单组。您不会在其中一个条目中找到此设置。您必须选择Editor“组”本身,它会在选项所在的右侧显示一个设置页面。
    【解决方案4】:

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

    IntelliJ 14

    Editor / General -> 显示鼠标移动的快速文档

    旧版本

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

    auto.show.quick.doc=true
    

    【讨论】:

      【解决方案5】:

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

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

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

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

      【讨论】:

        【解决方案6】:

        为了最好地反映 Eclipses 功能,请启用以下设置:

        • IDE 设置/编辑器 -> Other.Show quick doc on mouse move
        • IDE 设置/编辑器/代码完成 -> 自动弹出文档

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

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

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


        编辑: 除了最初的问题之外,这对于只想快速轻松地访问文档的人来说可能很有用。

        在使用了几天之后,似乎习惯使用热键是最有效的方法。它会在您的文本输入标记所在的位置弹出任何内容的文档,因此您无需触摸鼠标。这也适用于智能感知弹出窗口,并且在上下导航时会保持不变。

        就个人而言,Windows 上的 Ctrl+Q 并不理想,因此我将其重新映射为 Alt+D。重新映射可以在 IDE Settings/Keymap 下完成。进入键盘映射菜单后,只需搜索 Quick Documentation。

        【讨论】:

          【解决方案7】:

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

          【讨论】:

            【解决方案8】:

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

            【讨论】:

              【解决方案9】:

              IntelliJ IDEA 15 添加了此功能

              现在它可以作为 EAP 使用。

              如下图所示,插入符号的位置不会影响光标位置:

              This featureIntelliJ IDEA 15 142.4675.3 Release Notes 中实现。

              【讨论】:

                【解决方案10】:

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

                它在 IntelliJ 中被称为 Quick Doc,我希望 JetBrains 的人有朝一日可以使用 Ctrl+Mouse Move 来添加像 Eclipse 这样的快速文档,这样会更好。

                在我的例子中,只有鼠标移动有点烦人,所以如果你在 Preferences/Settings --> Keymap 中搜索“快速文档”,你会发现:

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

                【讨论】:

                  【解决方案11】:

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

                  【讨论】:

                    猜你喜欢
                    • 2013-07-10
                    • 2017-03-17
                    • 1970-01-01
                    • 2019-06-19
                    • 2011-12-17
                    • 1970-01-01
                    • 2022-11-24
                    • 1970-01-01
                    相关资源
                    最近更新 更多