Question

Pycharm为我提供了以下docstring模板：

    """

    :param var1: 
    :param var2: 
    """

表示函数def func(var1,var2)。

为什么Pycharm使用这个模板？是否有一些PEP或（不成文）约定，这是一种好的风格？

Answer 1

默认情况下，Pycharm使用reStructuredText。可以在设置→工具→Python集成工具中更改模板。目前，有5种样式可供选择：Plain，Epytext，reStructuredText，NumPy，Google。

PEP 287建议将reStructuredText作为文档字符串的标准格式。