我想为每个字段编写一次Javadoc注释,并在getter和setter方法中访问现有字段的Javadoc。
我知道有用于引用父方法文档的{@inheritDoc}
标签,但我想包含一个字段的文档,这当然不是父方法。
是否可以使用 Javadoc "不要重复自己"?
我在getters上添加javadoc注释,并在字段上添加{@link MyObject#get..()}
。
因此,对于我的 API/对象的用户来说,它很容易阅读,如果我想获取更多信息,我(或其他开发人员)只需将鼠标悬停在我的私有字段上。
除了@see
,不知道如何。
但是,如果您正在生成内部文档,则实际上不需要记录getter/setter。如果要生成外部文档,则无论如何都不会记录私有属性。
(说实话,有一次我有一组相当壮观的脚本/等,由于Java工具链中的各种限制,它们可以处理Java源代码并做这样神奇的事情。我前段时间放弃了它,现在 IDE 要好得多,但有些事情,比如将多个文件编织成单个类等等,真的很方便。有点像假混音,一些文档魔法等)
(实际上,链接到的 Spoon 项目与我正在做的事情非常相似,但在 1.5 之前。
这种样板可以通过使用龙目岛项目来避免。只需记录字段变量,即使它是private
,并让龙目岛注释生成正确记录的getter和setter。
对我来说,仅此一项好处就值得付出代价。