如何根据 Eclipse 中的字段注释自动生成 getter/setter 的注释？

eclipse java javadoc

2022-09-01 13:15:07

我希望 Eclipse 能够根据之前为字段定义的注释，为我的 getter 和 setter 方法自动生成 Javadoc 注释。我怎样才能做到这一点？

背景：我们公司的政策是评论每个方法和字段（即使它们具有不言自明的名称）。因此，我必须通过描述字段并再次描述getters /setter来做多余的工作。

例：

/**
 * name of the dynamic strategy
 */
private String dynName;

/**
 * get the name of the dynamic strategy
 * @return
 */
public String getDynName() {
    return dynName;
}

搜索网络显示我不是唯一一个有问题的人 - 但我找不到任何解决方案。我检查了 http://jautodoc.sourceforge.net/，但似乎它没有能力做到这一点。

答案 1

自版本1.6（问题发布1年后）以来，JAutodoc有一个新选项“[G，S]etter from field comment”，它完全符合您的要求。

这是一个非常方便的功能。字段注释通常不包含在最终的Javadoc HTML中，因为它们可能/应该是私有成员（为每个私有成员生成Javadoc也不好），所以如果没有它，注释将完全丢失！

我想知道这个问答线程是否可能促使作者实现这个不错的功能。

答案 2

我终于自己找到了解决方案（或者至少是一个解决方法）。我在SO上读到了关于勺子的文章。它是一个Java程序处理器，允许读取和修改java源文件。它甚至可以用作Eclipse插件或Ant/Maven脚本。

你所要做的就是扩展 AbstractProcessor，它将处理一个方法。如果方法名称以 get/set 开头，它会查找相应的字段，提取其注释并用它来替换或扩展访问器注释。

我有一个小蚂蚁脚本，它获取我的所有来源并处理它们。

集成在 eclipses 代码模板中的东西当然会更方便，但现在这种方式是可以的！