如何为PyCharm快速文档功能中可见的Python变量创建文档?

时间:2018-07-18 18:03:31

标签: python pycharm

我有一个名为PushButtonType.py的文件,其中定义了两个变量:

OK = 0  # acts like a OK button.

""" acts like a cancel button. """
CANCEL = 0

在另一个文件中,我导入并使用这些变量:

from PushButtonType import CANCEL, OK

foo = CANCEL
bar = OK

我希望第一个文件中的注释在PyCharm的快速文档(Ctrl + Q)功能中可见。当前,当我将光标放在一个变量上并按Ctrl + Q时,会显示一条消息“找不到文档”(请参见下面的屏幕截图)。

我希望这些注释在快速文档弹出窗口中可见。我怎样才能做到这一点?有一些特殊的评论格式吗?

Quick documentation popup in PyCharm

1 个答案:

答案 0 :(得分:2)

使用2018.2 EAP

bar = 1
"""bar variable"""

enter image description here