私有字段javadoc自动传播到getter/setter?

Nag*_*gyI 9 java documentation javadoc

我用Javadoc记录了我的bean私有字段,解释了每个字段的用途.我可以以某种方式将这些文档传播给反复使用的getter/setter以减少文档的重复吗?至少是否有某种Javadoc宏?

小智 5

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

{@link Class#field}
Run Code Online (Sandbox Code Playgroud)

但是我不会真的推荐这个.正如之前的评论员所说,我只是恰当地记录了吸气剂和制定者.Javadoc记录了getter和setter可能属于的公共API.您的私有字段不属于公共API.

  • 也许相反:添加从字段到getter/setter的链接,所以无论谁用`-private`查看文档都可以跳转到描述. (3认同)