java - 私有(private)字段 javadoc 自动传播到 getters/setters？

Question

我已经用 Javadoc 记录了我的 bean 私有(private)字段，解释了每个字段的用途。我可以以某种方式将这些文档传播到相应的 getter/setter 以减少文档的重复吗？至少有某种 Javadoc 宏吗？

Answer 1

您可以通过添加 javadoc 链接将 getter 和 setter 的 javadoc 注释链接到私有(private)字段:

{@link Class#field}

但是我真的不推荐这个。正如之前的评论员所说，我只会正确记录 getter 和 setter。 Javadoc 记录了您的公共(public) API，getter 和 setter 可能属于这些 API。您的私有(private)字段不属于公共(public) API。