使用Pycharm生成与Sphinx autodoc兼容的文档字符串

Question

当你开始编写函数时，Pycharm 5.0会自动填充docstring：

然而，这种格式似乎没有遵循任何良好的最佳实践。如何更改此设置，以便参数采用Sphinx autodoc格式：

def communicate(self, bytes):
     """Communicate with devices

     :param bytes: Outgoing request as array of bytes
     """

Answer 1

您可以转到文件 - ＆gt;更改默认文档字符串格式设置 - ＆gt;工具 - ＆gt; Python集成工具，以＆＃34; Docstring格式表示您的选择风格＆＃34;下拉框。