我希望 Eclipse 根据先前定义的字段注释自动为我的 getter 和 setter 方法生成 Javadoc 注释。我怎样才能实现这个目标?
背景:我们公司的一项政策是对每个方法和字段进行注释(即使它们具有不言自明的名称)。因此,我必须通过再次描述字段并描述 getter/setter 来完成多余的工作。
Example:
/**
* name of the dynamic strategy
*/
private String dynName;
/**
* get the name of the dynamic strategy
* @return
*/
public String getDynName() {
return dynName;
}
网上搜索表明我不是唯一遇到这个问题的人 - 但我找不到任何解决方案。我结帐了http://jaautodoc.sourceforge.net/ http://jautodoc.sourceforge.net/但似乎它无法做到这一点。
JAutodoc 自 1.6 版(问题提出一年后)开始有一个新选项“[G,S]etter from field comment”,它正是您想要的。
这是一个非常方便的功能。字段注释通常不包含在最终的 Javadoc HTML 中,因为它们可能/应该是私有成员(为每个私有成员生成 Javadoc 也不好),因此如果没有它,注释将完全丢失!
我想知道这个 Q/A 线程是否会激励作者实现这个不错的功能。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)