在 eclipse 的 Python 源代码中自动生成虚拟文档答案

【问题标题】：Autogenerate dummy documentation in the source code for Python in eclipse在 eclipse 的 Python 源代码中自动生成虚拟文档
【发布时间】：2011-11-21 23:19:04
【问题描述】：

当时我正在记录我的很多代码（Python），我想知道是否有一个 Eclipse 插件可以为我的函数自动生成一个文档字符串，就像 Visual Studio 在编写 @987654321 时为 C# 所做的那样@ 一个方法。

我一直在寻找解决方案，但没有运气 - 你们中有人知道解决方案吗？

示例：

从我的方法参数列表中，将在我的方法定义下创建“虚拟”文档，如下所示：

def myFunction(self, a, b):
    """

    :param a:
    :type a:
    :param b:
    :type b:
    :return:
    :rtype:
    """
    return 'Hello, world'

【问题讨论】：

我认为总的来说，这违背了 python 的精神。参数应该通过它们可能冗长的名称进行自我记录。 Python 使用类型推断，因此，如果参数类型与预期的参数类型不匹配，单元测试应该会失败。一行文档就足够了。
在很多方面我都同意你的观点，但是，我不会像我的最终用户那样做。他无法访问单元测试，而且我相信一个比我的参数名称更详细的文档化代码会让他的生活更轻松，他可以更快地启动和运行我的 API。（成本更低）
我明白你的意思，但我会省略类型信息。

标签： python eclipse plugins documentation pydev

【解决方案1】：

嗯，根据this doc，如果你在方法名上按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 更改为双倍，但是，由于我的文档工具（Sphinx ) '@' 必须更改为 ':' 才能工作，但我真的不知道这是否可能！
@aweis : 我找到了如何添加参数的类型（还没有找到如何将@更改为:)
嗨，有些我没有这个类型了，你做了什么来自动生成它？ - 如果我也得到类型参数，我可以忍受我需要手动更改@的事实
非常好，谢谢 :) 有趣的是，在更改 doctag 值时，我被问到“参数前缀”，也许有一个功能在 PyDev 中没有完全实现 :)