Pycharm 文档模板

Pycharm documentation template

Pycharm 为我提供了以下文档字符串模板:

    """

    :param var1: 
    :param var2: 
    """

函数 def func(var1,var2).

为什么 Pycharm 使用这个模板?是否有一些 PEP 或(不成文的)约定认为这是好的风格?

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

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