如何为Python变量创建文档,这些变量将在PyCharm快速文档功能中可见?

2024-05-16 05:12:42 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个名为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


Tags: 文件from文档pyimport定义评论button