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

Question

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

背景:我们公司的一项政策是评论每个方法和领域(即使它们具有不言自明的名称).因此,我必须通过描述字段并再次描述getter/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/,但似乎无法做到这一点.

Answer 1

JAutodoc从版本1.6(问题后1年)有一个新选项"[G,S] etter from field comment",它完全符合您的要求.

这是一个非常方便的功能.字段注释通常不包含在最终的Javadoc HTML中,因为它们可能/应该是私有成员(为每个私有成员生成Javadoc也不好),因此如果没有它,注释将完全丢失!

我想知道这个Q/A线程是否可能激励作者实现这个不错的功能.

Answer 2

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

您需要做的就是扩展AbstractProcessor,它将处理一个方法.如果方法名称以get/set开头,它将查找相应的字段,提取其注释并替换或扩展访问者注释.

我有一个小蚂蚁脚本,它采用我的所有来源并处理它们.

在日食代码模板中集成的东西当然会更方便,但是现在这种方式还可以!