【问题标题】:PyCharm not inserting docstring stub for class?PyCharm 没有为类插入文档字符串存根?
【发布时间】:2018-07-24 13:38:16
【问题描述】:

我有以下代码:

class Note:
    def __init__(self, note=None, duration=None, start_time=None):
        self.note = note
        self.duration = duration
        self.start_time = start_time

我想根据 NumPy 文档字符串样式为类生成文档字符串,但它不会自动完成。我在File | Settings | Tools | Python Integrated Tools下的设置中选择了NumPy格式

def __init__() 的自动完成作品。当我在它之后开始一个新行并输入'''时,它会自动插入:

'''

Parameters
----------
note :
duration :
start_time :
'''

但是当我在class Note: 下做同样的事情时,它不会那样做。我正在使用 PyCharm 2017.3.3

【问题讨论】:

  • 遇到同样的问题,可惜IDE不支持这个功能
  • 还是这样吗?我正在使用 PyCharm 的 CE 版本,我无法让它的文档注释存根在类上工作(它只在函数/方法上工作)——如何还没有构建类级别的自动文档功能!?我觉得我错过了一些东西,例如,在这个链接中,“ExampleError”类文档肯定是自动生成的:sphinxcontrib-napoleon.readthedocs.io/en/latest/…
  • @CubeBot88 是的,我自己又试了一次,但它仍然没有自动插入。我同意您提供的示例可能是自动生成的,但我猜开发人员可能刚刚使用了其他一些工具或 IDE。我知道 VS Code 有一个插件 marketplace.visualstudio.com/…

标签: python pycharm stub docstring


【解决方案1】:

这似乎是一个没有当前截止日期或版本的功能请求: https://youtrack.jetbrains.com/issue/PY-16760

【讨论】:

    猜你喜欢
    • 2013-09-11
    • 1970-01-01
    • 2015-05-18
    • 2012-04-08
    • 1970-01-01
    • 2014-07-14
    • 2013-12-27
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多