我想为每个字段编写一次 Javadoc 注释，并在 getter 和 setter 方法中访问现有字段的 Javadoc。
我知道有{@inheritDoc}引用父方法文档的标签，但我想包含一个字段的文档，这当然不是父方法。
使用 Javadoc 是否可以“不要重复自己”？
问问题
1732 次
3 回答
2
除了@see，不知道如何。
但是，如果您正在生成内部文档，则实际上不需要记录 getter/setter。如果您正在生成外部文档，则无论如何您都不会记录私有属性。
（说实话，由于 Java 工具链中的各种限制，我曾经有一组相当壮观的脚本/等，它们可以处理 Java 源代码并做类似这样的神奇事情。我前段时间放弃了它，现在IDE 要好得多，但也有一些东西，比如将多个文件编入单个类等等，这些东西真的很方便。有点像假的 mixins，一些 doc 魔术等）
（实际上，链接到的 Spoon 项目与我正在做的非常相似，但在 1.5 之前。）
于 2012-05-29T19:29:52.117 回答
2
我在我的 getter 上添加 javadoc 注释并{@link MyObject#get..()}在字段上添加一个。
因此，对于我的 API/对象的用户来说，它很容易阅读，如果我想获得更多信息，我（或其他开发人员）只需将鼠标悬停在我的私有字段上。
于 2013-09-11T07:01:49.183 回答
1
使用Project Lombok可以避免这种样板文件。只需记录字段变量，即使它是private，并让 Lombok 注释生成正确记录的 getter 和 setter。
对我来说，光是这个好处就值得付出代价。
于 2014-02-11T02:00:51.217 回答