自定义PyCharm文档字符串存根(即用于google docstring或numpydoc格式)


75

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

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


Answers:


102

有了PyCharm 5.0,我们终于选择了Google和NumPy Style Python Docstrings模板。

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

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

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

您可以在其中选择可用的文档字符串格式:

普通,Epytext,reStructuredText,NumPy,Google

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

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


8
对于Mac用户,这位于PyCharm->首选项->工具-> Python集成工具下。
jstol 2016年

3
任何想法,当我开始一个新项目时,如何使选择保持不变?每次不得不寻找这个设置是很痛苦的。
superbeck

1
考虑更新此答案以将信息包括在jstol的评论中
Kane C


By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.