我可以避免在getter/setter方法中重复字段的Javadoc注释吗?

Jef*_*rod 5 javadoc dry getter-setter

我想为每个字段编写一次Javadoc注释,并在getter和setter方法中访问exiting字段的Javadoc.

我知道有{@inheritDoc}用于引用父方法文档的标记,但我想要包含字段的文档,当然这不是父方法.

是否有可能与Javadoc"不重复自己"?

Dav*_*ton 2

除此之外@see,不知道如何。

但如果您要生成内部文档,则实际上不需要记录 getter/setter。如果您要生成外部文档,则无论如何都不会记录私有属性。

(说实话,由于 Java 工具链中的各种限制,我曾经有一组相当壮观的脚本/等等,可以处理 Java 源代码并执行类似的神奇操作。我不久前放弃了它,因为IDE 好多了,但是有一些东西,比如将多个文件编织到单个类中,等等,这确实很方便。有点像假 mixin、一些文档魔法等等。)

(实际上,链接到的 Spoon 项目与我正在做的非常相似,但是是 1.5 之前的版本。)

  • 在 Eclipse 中,除了在 setter/getter 中包含字段文档或“@See”之外,我是否必须首先导航到 setter 方法,然后将鼠标悬停在字段引用上才能访问 javadoc?理想情况下,我只需将鼠标悬停在 getter/setter 上,然后找出我打算使用该字段做什么。:) (2认同)