我想解析一个numpydoc文档字符串并以编程方式访问每个组件。例如:deffoobar(a,b):'''SomethingsomethingParameters----------a:int,default:5Doessomethingcoolb:strWow'''我想做的是:parsed=magic_parser(foobar)parsed.text#Somethingsomethingparsed.a.text#Doessomethingcoolparsed.a.type#intparsed.a.default#5我一直在四处搜索，发现了类似numpydoc的东西和napoleo

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭4年前。Improvethisquestion我正在从事一个需要Numpy文档的项目。在我使用Java的日子里，我记得有linters检查Eclipse/IDEA中的Javadoc遵守情况；是否有检查Numpy文档样式遵守情况的等效项？我知道PEP257，但它似乎没有针对Numpy文档的任何特定检查。

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我正在使用Numpy-styledocstrings为Python项目编写文档.numpydoc和napoleon是两个Sphinx扩展，它们解析Numpy风格的文档字符串以生成文档。第一个用于Numpy项目本身，第二个随Sphinx一起提供。使用一种扩展程序相对于另一种扩展程序的优缺点是什么？

假设我有以下记录在Numpydocstyle中的函数,并且文档是使用Sphinx自动生成的autofunctiondirective:deffoo(x,y,_hidden_argument=None):"""Fooabar.Parameters----------x:strThefirstargumenttofoo.y:strThesecondargumenttofoo.Returns-------Thebarredfoo."""if_hidden_argument:_end_users_shouldnt_call_this_function(x,y)returnx+y我不想将隐藏参数

假设我有以下记录在Numpydocstyle中的函数,并且文档是使用Sphinx自动生成的autofunctiondirective:deffoo(x,y,_hidden_argument=None):"""Fooabar.Parameters----------x:strThefirstargumenttofoo.y:strThesecondargumenttofoo.Returns-------Thebarredfoo."""if_hidden_argument:_end_users_shouldnt_call_this_function(x,y)returnx+y我不想将隐藏参数

PyCharm2.7(或PyCharm3)是否支持自定义docstring和docteststub？如果是这样，如何编写这种特定类型的自定义扩展？我当前的项目已标准化使用GooglePython样式指南(http://google-styleguide.googlecode.com/svn/trunk/pyguide.html)。我喜欢PyCharm的docstring支持，但现在只有两种支持的格式是epytext和reStructureText。我想要并且愿意自己编写一个PyCharm插件，它可以创建以Google或Numpydoc样式(https://pypi.python.org