在重载方法上编写Javadoc的DRY方法


Answers:


3

{@inheritDoc}当从超类覆盖方法或实现接口定义的方法时,我会在Javadoc注释中四处散布指令。

至少对我来说这很好,避免了源代码中的重复,如果需要,您仍然可以在特定的Javadoc注释中添加特定的信息。我不认为当一个体面的IDE所需要的只是悬停在关联的标识符名称上以获取具有引用和所有内容的Javadoc时,Javadoc注释本身几乎不会成为一个问题。


2

文档的重点是阐明某个项目的未来用户。这部分是为了给作者提供方便,这样,只要有人无法弄清楚事情的发展原理,就不必与他或她联系。但是,大多数情况下,这是为需要使用或支持事物的人们的利益。

因此,重点应该是清楚的,而不是给作者带来方便。您不能期望人们在您的API文档中四处寻觅,因为您本质上太懒了以至于无法重复自己。总结一下-Javadoc将是重复的。

就是说,没有理由,如果您很聪明,就不能编写一个程序来根据标记或其他一些标准将注释粘贴到您的代码中。这可能比它的价值还要麻烦。或不。


4
不,不要重复自己;保持一切同步只是更多的开销。如果有关于重载实现的新信息,则仅编写该信息。我认为期望某种类型的用户查看其超类型的javadocs是合理的,并且诸如Eclipse之类的工具使他们这样做非常容易。
达伍德·伊本·卡里姆
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.