java - Java中重写方法的评论

Question

我们是否应该评论被覆盖的方法？如果是，那么注释是 Java Doc 还是简单注释？

Answer 1

@SimonC 的回答解释了 javadoc 实用程序如何为被覆盖的方法生成“继承”文档。

您还可以将显式 javadocs 放在覆盖方法中，它们将优先于继承的 javadocs。此外，如果您将 {@inheritDoc} 标记放在覆盖方法的显式 javadocs 中，那么继承的注释将被包含在内。

回答这个问题:

Should we comment the overridden method or not? If yes, then whether the comment will be a Java Doc or simple comment?

在我看来，如果覆盖方法改进了被覆盖方法的记录语义(契约(Contract))(或者......天堂禁止......违反契约(Contract))，那么这应该记录在覆盖方法的 javadocs 中。但是，如果差异仅仅是“实现细节”，那么简单的注释(或没有注释)更合适。

(但是，在 IMO 中，包含“非 javadoc”注释以将读者引回被覆盖方法的 javadoc 的做法是浪费屏幕空间......当我阅读源代码时。)