81

PyCharm 2.7(或 PyCharm 3)是否支持自定义 docstring 和 doctest 存根?如果是这样,如何编写这种特定类型的自定义扩展?

我当前的项目已标准化使用 Google Python 样式指南 ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html )。我喜欢 PyCharm 的 docstring 支持,但现在只有两种支持的格式是 epytext 和 reStructureText。我想要并且愿意自己编写一个 PyCharm 插件,它可以创建一个以 Google 或 Numpydoc 样式(https://pypi.python.org/pypi/sphinxcontrib-napoleon/)格式化的文档注释存根。这里特别重要的是将 PyCharm 具有的类型推断能力与其他两种文档类型结合起来。

4

3 回答 3

108

在 PyCharm 5.0 中,我们最终选择了Google 和 NumPy Style Python Docstrings模板。

PyCharm 5.0的whatsnew部分也提到了它。

如何更改文档字符串格式:

文件 --> 设置 --> 工具 --> Python 集成工具

在那里,您可以从可用的 Docstrings 格式中进行选择:

普通文本、Epytext、reStructuredText、NumPy、谷歌

正如jstol所指出的:对于Mac用户,这是在

PyCharm -> 首选项 -> 工具 -> Python 集成工具。

于 2015-11-03T11:20:31.113 回答
4

正如 CrazyCoder 提到的,它是一张票。目前,您只能使用EpyTypereStructuredText

于 2013-10-14T09:14:20.947 回答
1

从PyCharm 5.0开始,让@Nras 明确回答:

文件 > 设置 > 工具 > Python 集成工具 > 文档字符串 > Google

于 2015-12-27T21:13:46.260 回答