如何记录覆盖另一种方法的方法？

Question

我总是想知道如何记录一个覆盖基类消息的方法。 通常我会向每个公共方法和一些私有的受保护方法添加一个java文档。

但autogenerating一个文件块在Eclipse中的覆盖方法产生这样的：

/* 
* (non-Javadoc) 
* 
* @see javax.swing.JComponent#paintComponent(java.awt.Graphics) 
*/ 

这是记录覆盖的好办法？我应该从基类继承/复制文档吗？

作为这种特殊情况的文档，你在做什么？ 我想概述一下使用的实践。

Answer 1

每种方法 - 私人的，受保护的公共 - 都应该形成文件来描述它的功能。忘记从基类继承文档 - 如果你愿意，你可以包含一个链接，但只要信息覆盖了继承的方法，那么另一个人就可以自由地查找它。干 - 不要重复自己 - 只在一个地方记录基类方法。

我甚至不认为记录它覆盖的方法是好的，因为这可能会改变，如果在类和基类之间的层次结构中插入新类，将难以保持最新状态。只是它覆盖继承方法的信息就足够了。

如果您的方法过于复杂，无法在几行注释中记录，那么它们可能太复杂，应该重构。

Answer 2

包括@Override注释应该足以让一个好奇的开发人员发送给超级用户。