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

Question

当我使用参数创建一个函数时，PyCharm让我使用:param param_name:字段创建文档字符串，这非常好。但我还需要添加: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

对于the documentation：

如果configured，可以使用type和rtype标签生成文档注释存根。

点击链接：

...

3. 在Smart Keys页面中，选中“将'type'和'rtype'复选框插入文档注释存根。

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

Answer 2

在首选项设置中：

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

check this screenshot as reference

Answer 3

只需启用此复选框：

编辑器 - 常规 - 智能密钥 - 在文档注释存根中插入类型占位符。

还要记得启用此项，以便您可以使用Alt + enter来自动插入文档：

编辑 - 常规 - 智能键 - 插入文档注释存根

Answer 4

你问的问题已被回复，但我发现你可以使用相关信息

def foo(bar, xyz):
    """


    :param bar_type bar:
    :param xyz_type xyz:
    """
    return bar + xyz

使用指示bar_type和xyz_type变量的类型。一个很好的提示是你可以使用|来设置多种可能的类型。例：

def foo(bar, xyz):
    """


    :param float|int bar:
    :param numpy.array xyz:
    """
    return bar + xyz