首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >自定义PyCharm文档字符串存根(例如,用于谷歌文档字符串或numpydoc格式)

自定义PyCharm文档字符串存根(例如,用于谷歌文档字符串或numpydoc格式)
EN

Stack Overflow用户
提问于 2013-09-07 05:31:38
回答 3查看 19.7K关注 0票数 79

PyCharm 2.7 (或PyCharm 3)是否支持自定义文档字符串和文档测试存根?如果是这样,如何编写这种特定类型的自定义扩展呢?

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

EN

回答 3

Stack Overflow用户

回答已采纳

发布于 2015-11-03 19:20:31

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

在PyCharm 5.0的whatsnew部分中也提到了这一点。

如何更改Docstring格式:

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

在这里,您可以从可用的Docstring格式中选择:

纯文本、Epytext、reStructuredText、NumPy、谷歌

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

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

票数 105
EN

Stack Overflow用户

发布于 2013-10-14 17:14:21

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

票数 4
EN

Stack Overflow用户

发布于 2015-12-28 05:13:46

只是为了让@Nras的答案更明确,比如PyCharm 5.0

谷歌文件>设置>工具>

集成工具>文档字符串>

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/18666885

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档