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

Question

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

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

使用Javadoc是否可以“不重复自己”？

Answer 1

除@see以外，不确定如何。

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

（说实话，有一点我有一套相当壮观的脚本/等等，由于Java工具链中的各种限制，它会处理Java源代码并做这样的神奇事情。我放弃了一段时间既然IDE现在好多了，但有一些东西，比如将多个文件编织成单个类，以及真正方便的东西。有点像假混合，一些doc魔术等等。）

（实际上，与之相关的Spoon项目与我正在做的非常相似，但是在1.5之前。）

Answer 2

我在我的getter上添加了javadoc注释，并在该字段上添加了{@link MyObject#get..()}。

因此，如果我想获取更多信息，那么我的API /对象的用户很容易阅读，而我（或其他开发人员）只需将鼠标悬停在我的私有字段上。

Answer 3

使用Project Lombok可以避免使用这种样板文件。只记录字段变量，即使它是private，并让Lombok注释生成正确记录的getter和setter。

对我来说，这个好处值得costs。