我总是想知道如何记录覆盖基类消息的方法。 通常我会为每个公共方法和一些私有的受保护方法添加一个java doc。
但是在eclipse中为替换方法自动生成文档块会产生如下所示：
/*
* (non-Javadoc)
*
* @see javax.swing.JComponent#paintComponent(java.awt.Graphics)
*/
这是记录覆盖的好方法吗？我应该从基类继承/复制文档吗？
你在做什么作为这个特例的文件？ 我想概述一下所使用的实践。
答案 0 :(得分：10)
每个方法 - 私人的，受保护的公众 - 都应该记录下来，描述它的作用。忘记从基类继承文档 - 如果你愿意，你可以包含一个链接，但只要信息覆盖了一个继承的方法，那么另一个人就可以自己查找它。干 - 不要重复自己 - 仅在一个地方记录基类方法。
我甚至认为记录它覆盖的方法是好的，因为如果在类和基类之间的层次结构中插入新类，那么它可能会更改并且很难保持最新状态。简单地说，它覆盖继承方法的信息就足够了。
如果你的方法太复杂，无法在几行评论中记录，那么它们可能过于复杂，应该重构。
答案 1 :(得分：1)
包括@Override注释应该足以将一个好奇的开发者发送给super。