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

jckbn6z7 于 2022-11-08 发布在 PyCharm

关注(0)|答案(3)|浏览(210)

PyCharm2.7（或者PyCharm3）是否支持自定义的文档字符串和文档测试存根？如果是的话，如何编写这种特定类型的自定义扩展？
我目前的项目已经标准化了使用GooglePython样式指南（http://google-styleguide.googlecode.com/svn/trunk/pyguide.html）。我喜欢PyCharm的docstring支持，但目前它只支持两种格式：epytext和reStructureText。我希望，也愿意自己编写，一个PyCharm插件，用于创建Google或Numpydoc样式的文档注解存根（https://pypi.python.org/pypi/sphinxcontrib-napoleon/）。这里特别重要的是将PyCharm所具有的类型推理能力与其他两个文档类型相结合。

pycharm

来源：https://stackoverflow.com/questions/18666885/custom-pycharm-docstring-stubs-i-e-for-google-docstring-or-numpydoc-formats

3条答案

按热度按时间

xoshrz7s1#

在PyCharm 5.0中，我们最终选择了Google and NumPy Style Python Docstrings模板。
在PyCharm 5.0的whatsnew部分中也提到了这一点。
如何更改文档字符串格式：
文件--〉设置--〉工具--〉Python集成工具
您可以在此从可用的Docstrings格式中进行选择：
纯文本、电子文本、重组文本、NumPy、Google
正如jstol所指出的：对于Mac用户，这位于
PyCharm -〉首选项-〉工具-〉Python集成工具。