PyCharm / IntelliJ用于Python文档字符串的样式是什么?

时间:2017-09-21 14:48:30

标签: python intellij-idea pycharm docstring

我正在尝试理解关于创建文档字符串的“解决方案生态系统”,然后使用PyCharm / IntelliJ生成一些不错的参考文档。

我已经习惯了Google风格的文档字符串,但我对PyCharm默认的docstring框架格式/样式感到困惑:

"""
:param <paramname>: blah blah
:return None
"""

这是什么样的风格和哪些参考文档生成器可以使用?某处有风格指南吗?

1 个答案:

答案 0 :(得分:3)

这些是Sphinx样式的doc字符串。

Python对文档字符串有一些强烈的看法,请参阅PEP257

以下是Python中所有文档字符串类型的完整描述:What is the standard Python docstring format?