Question

我在找出在Pycharm中记录方法以获得类型提示和参数描述的正确方法时遇到了一些麻烦。

在Pycharm's documentation中建议：

：param“type_name”“param_name”：“param_description”

（1）但是，当我尝试使用它时，函数定义没有正确显示参数说明：

（2）如果我用@符号切换到前导，我会得到一个参数列表及其类型，但我没有得到参数说明：

（3）如果我坚持使用@符号并删除类型，我会得到参数说明：

（4）如果我为每个@type明确添加@param（这会完全炸掉评论块的大小），一切正常（但我讨厌评论的大小）：< / p>

（5）最后，为了完整起见，使用:代替@会导致所有内容无法填充：

请注意，我已尝试更改Pycharm中的文档系统，但它不会影响它呈现文档的方式 - 它似乎只影响它为您自动填充注释块的方式。

如何实现文档尽可能接近紧凑的示例（1），但实际上是否正确填充了函数定义？我讨厌坚持风格（4）。

Answer 1

从Pycharm: Auto generate `:type param:` field in docstring直接复制：

每the documentation：

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

点击链接：

...


在Smart Keys页面中，选中复选框插入＆＃39;输入＆＃39;和   ＆＃39;舍入类型＆＃39;到文档评论存根。

完成此操作后，将光标放在定义中的参数名称中，激活智能键功能（默认情况下为 Alt + Enter ）并选择< strong>指定docstring中的引用类型。这将插入适当的注释行。类似地，您可以将光标放在函数/方法名称中，然后选择在docstring中指定返回类型。

现在，如果您在函数声明后键入"""，它会自动为您创建它们：

def funct(a, b, c):
    """

    :param a: 
    :type a: 
    :param b: 
    :type b: 
    :param c: 
    :type c: 
    :return: 
    :rtype: 
    """

Answer 2

您检查过设置... - 工具 - Python集成工具 - 文档字符串格式？您可以选择解析样式。

您可以选择：

纯
Epytext
reStructuredText的
numpy的
谷歌

Answer 3

它适用于最新版本的PyCharm（2016.2 CE），甚至还有一些以前的修补版本。

it works! (Screenshot)

我问了类似的问题并得到了答案！

PyCharm and reStructuredText (Sphinx) documentation popups

使用PyCharm在docstring中记录Python参数

3 个答案: