eclipse中Python源代码中的自动生成虚拟文档
当时我正在记录我的许多代码(Python),我想知道Eclipse是否有一个插件可以自动为我的函数生成文档字符串,就像visual studio在通过方法编写eclipse中Python源代码中的自动生成虚拟文档,python,eclipse,plugins,documentation,pydev,Python,Eclipse,Plugins,Documentation,Pydev,当时我正在记录我的许多代码(Python),我想知道Eclipse是否有一个插件可以自动为我的函数生成文档字符串,就像visual studio在通过方法编写//时为C#所做的那样 我一直在四处寻找解决办法,但我运气不好——你们中有人知道解决办法吗 示例: 从我的方法参数列表中,将在我的方法定义下创建“虚拟”文档,如下所示: def myFunction(self, a, b): """ :param a: :type a: :param b: :typ
//
时为C#所做的那样
我一直在四处寻找解决办法,但我运气不好——你们中有人知道解决办法吗
示例:
从我的方法参数列表中,将在我的方法定义下创建“虚拟”文档,如下所示:
def myFunction(self, a, b):
"""
:param a:
:type a:
:param b:
:type b:
:return:
:rtype:
"""
return 'Hello, world'
根据,如果在方法名上按Ctrl+1,您将得到所需的内容
对于您的示例(编辑:如果您将选项PyDev>Editor>Code Style>Docstrings>Doctag generation设置为始终以获取参数的类型),您将获得:
def myFunction(self, a, b):
'''
@param a:
@type a:
@param b:
@type b:
'''
return 'Hello, world'
我没有发现,但它非常接近:)我可以在Eclipse的首选项中看到,我可以将单个qoute更改为双qoute,但是,由于我的文档工具(Sphinx),必须将“@”更改为“:”才能工作,但我真的看不出这是否可行@aweis:我找到了如何添加参数的类型(还没有找到如何将@改为:)嗨,我怎么不再有这种类型了,你做了什么来自动生成它如果我也得到类型参数,我可以接受这样一个事实,即我需要手动更改@的值,非常好,谢谢:)有趣的是,当更改doctag值时,我被问及“参数前缀”,可能有一个功能在PyDev中没有完全实现:)我认为这总体上违背了python的精神。参数应通过其可能详细的名称进行自我记录。Python使用类型推断,因此,如果参数类型与预期的参数类型不匹配,单元测试应该失败。一行文档就足够了。在很多方面我同意你的观点,但是,我不喜欢我的最终用户做的事情。他没有访问单元测试的权限,我相信一个很好的文档化代码,它比我的参数名称更详细,使他的生活更轻松,他可以更快地启动和运行我的API。(而且成本更低)我明白你的意思,但我会省略类型信息。