Pycharm:在docstring中自动生成`:type param:`字段

Question

当我用参数创建一个函数时,PyCharm让我用:param param_name:字段创建docstring ,这非常好.但我还需要添加:type param_name:.

那样:

def foo(bar, xyz):
    return bar + xyz

使用生成docstring选项我有(即使使用文档存根启用的插入'类型'和'rtype'):

def foo(bar, xyz):
    """


    :param bar:
    :param xyz:
    """
    return bar + xyz

而我想的是:

def foo(bar, xyz):
    """


    :param bar:
    :type bar:
    :param xyz:
    :type xyz:
    """
    return bar + xyz

Answer 1

首先，检查您是否启用了 restructedText 插件。要进行检查，请转到首选项 - 插件 - restructedText（如果未启用，请选中该框以启用它）接下来，在同一首选项选项卡中，导航到工具 > Python 集成工具 > Docstrings

然后：

• 更改文档字符串格式：restructedText（而不是 Plain）
• 复选框“分析文档字符串中的 python 代码”
• 选中“渲染 stdlib 的外部文档”框

应用更改并关闭。

最后，要验证更改，请转到功能块并添加三个引号（单引号或双引号）并按 Enter 或空格，您应该看到自动生成的文档字符串。

Answer 2

根据文件:

如果已配置,则可以使用type和rtype标记生成文档注释存根.

点击链接:

...

3. 在" 智能密钥"页面中,选中"文件注释存根"中的" 插入"和"rtype"复选框.

完成此操作后,将光标放在定义中的参数名称中,激活智能键功能(默认情况下为Alt+ Enter),然后在docstring中选择指定类型以供参考.这将插入适当的注释行.类似地,您可以将光标放在函数/方法名称中,然后在docstring中选择Specify return type.

Answer 3

在首选项设置中：

智能键->“在文档注释存根中插入类型占位符”

检查此屏幕截图作为参考