在Eclipse中为Python自动生成源代码的虚拟文档
我现在正在给我的代码(Python)写很多文档,我想知道Eclipse有没有什么插件,可以像Visual Studio在写C#代码时那样,自动为我的函数生成文档字符串。当我在方法上方写///
时,它会自动生成文档。
我到处找解决办法,但一直没有找到——你们知道有什么解决方案吗?
举个例子:
根据我方法里的参数列表,"虚拟"文档会在我的方法定义下方生成,如下所示:
def myFunction(self, a, b):
"""
:param a:
:type a:
:param b:
:type b:
:return:
:rtype:
"""
return 'Hello, world'
1 个回答
7
根据这份文档,如果你在一个方法名称上按下 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'