【问题标题】:How to create documentation for Python variables that will be visible in PyCharm quick documentation functionality?如何为在 PyCharm 快速文档功能中可见的 Python 变量创建文档?
【发布时间】:2018-12-26 17:59:01
【问题描述】:

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

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

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

【问题讨论】:

    标签: python pycharm


    【解决方案1】:

    2018.2 EAP:

    bar = 1
    """bar variable"""
    

    【讨论】:

      猜你喜欢
      • 2019-12-03
      • 1970-01-01
      • 2020-04-27
      • 1970-01-01
      • 2014-05-17
      • 2019-11-17
      • 2021-09-03
      • 2022-01-18
      • 2018-05-19
      相关资源
      最近更新 更多