PyCharm / IntelliJ 对 Python 文档字符串使用什么风格？答案

【问题标题】：What style does PyCharm / IntelliJ use for Python docstrings?PyCharm / IntelliJ 对 Python 文档字符串使用什么风格？
【发布时间】：2018-03-02 23:45:02
【问题描述】：

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

我已经习惯了 Google 样式的文档字符串，但是对 PyCharm 的默认文档字符串骨架格式/样式感到困惑：

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

这是什么风格，它使用什么参考文档生成器？哪里有风格指南？

【问题讨论】：

那是reStructuredText 文档字符串样式。该样式由PEP 287 指定

标签： python intellij-idea pycharm docstring

【解决方案1】：

这些是Sphinx 样式的文档字符串。

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

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

【讨论】：