使用Pycharm生成Sphinx自动文档兼容的文档字符串

Question

3

当您开始编写函数时，Pycharm 5.0会自动完成docstring：

然而，这种格式似乎并不遵循任何良好的最佳实践。有什么方法可以更改它，使参数符合Sphinx autodoc格式？

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

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

- Mikko Ohtamaa

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- user2230827 · Accepted Answer

你可以通过转到文件 -> 设置 -> 工具 -> Python集成工具来更改默认的文档字符串格式，并在“文档字符串格式”下拉框中选择你喜欢的样式。 Sphinx使用reStructuredText。