自定义PyCharm docstring存根(即谷歌docstring或numpydoc格式)

时间:2013-09-06 21:31:38

标签: python pycharm docstring doctest

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与其他两种文档类型的类型推断能力。

3 个答案:

答案 0 :(得分:86)

使用PyCharm 5.0,我们最终选择Google and NumPy Style Python Docstrings模板。

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

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

  

档案 - >设置 - >工具 - > Python集成工具

您可以从可用的文档字符串格式中进行选择:

  

Plain,Epytext,reStructuredText,NumPy,Google

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

之下
  

PyCharm - >偏好 - >工具 - > Python集成工具。

答案 1 :(得分:4)

正如CrazyCoder所提到的,它是ticket。目前,您只能使用EpyTypereStructuredText

答案 2 :(得分:1)

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

  

档案>设置>工具> Python集成工具> Docstrings>   谷歌