如何在 PyCharm 中悬停时弹出文档？答案

【问题标题】：How can I make the documentation pop-up on hover in PyCharm?如何在 PyCharm 中悬停时弹出文档？
【发布时间】：2021-06-04 11:05:27
【问题描述】：

我想知道如何配置 PyCharm，以便当我将鼠标悬停在一个对象或方法上时，我会得到一个包含文档字符串的（格式化的）弹出窗口。我该怎么做？

【问题讨论】：

【解决方案1】：

原始功能请求票：http://youtrack.jetbrains.com/issue/IDEA-66333

如果您使用的 PyCharm 位于 131.xxx 分支或更新版本（可在“帮助 | 关于”上找到），则可以在 Settings/Preferences | Editor | General | Show quick doc on mouse move 下找到此类选项.

对于一些早期版本（当 GUI 控件尚不可用时），可以通过将 auto.show.quick.doc=true 添加到 IDE_INSTALL_FOLDER/bin/idea.properties 文件中来激活它。

现代 IDE 版本在 Settings/Preferences | Editor | Code Editing | Show quick documentation on mouse move 有它，并且默认启用：

（截图来自 PhpStorm，但选项名称和路径在基于 IDEA 的 IDE 中是相同的）

【讨论】：

不确定从哪个版本开始，但在 201.xxx 版本上，此选项在 Settings | Editor | Code Editing | Quick Documentation 下可用
@ktv6 201.xxx 构建？然后是 2020.1 版本 -- 还没有尝试过，先等待 2020.1.1 错误修复......但是是的，从 2020.1 开始，此选项默认启用（不确定它是否会影响现有安装或仅影响新安装）。
@ktv6 它已为我启用但仍不显示文档字符串

【解决方案2】：

当Settings | Editor | General | Show quick doc on mouse move 已经被选中时，寻找一个Documentation 的窗口，它是用Edit | Quick Documentation 显式打开的。

我几乎没有注意到那个窗口，但快速文档可能会出现在那里。相反，要显示文档悬停在鼠标附近，请右键单击 Documentation 工具窗口的标题并选择 Open as popup。

【讨论】：

【解决方案3】：

如果您在断点处停止，即使选中该框，PyCharm 也不会在悬停时显示快速文档，因为它处于“悬停时检查变量”模式。在这种情况下，请在悬停时按住 Cmd（在 Mac 上）。

【讨论】：