java - 我们应该扩展抽象类的 JavaDoc 类吗？

Question

假设我正在编写一个扩展抽象类“Work”的类“MyWork”。现在，假设我在“MyWork”中需要的所有方法都已经被声明并且已经在“Work”中编写了它们的 JavaDoc。我还应该在“MyWork”中添加 JavaDoc 吗？

干杯!

score 5 · Accepted Answer

这取决于。如果您没有覆盖任何方法，则没有添加 Javadoc 的选项（仅在类级别）。在类中添加一些 Javadoc 来解释它存在的原因可能是有意义的。

如果您要覆盖方法，则可以这样编写 Javadoc：

/**
 * {@inheritDoc}
 * This implementation also does...
 */

score 2 · Accepted Answer

2

对于非公开代码，我不会为任何@inheritDoc无法处理的事情而烦恼。

于 2013-03-23T16:00:02.093 回答

score 0 · Accepted Answer

除非中的方法MyWork覆盖中的任何功能Work，否则可以安全地假定这些方法的行为与其超类相似。不应该有任何理由记录非覆盖的方法或字段。

score 0 · Accepted Answer

我假设您正在谈论抽象方法，因此“MyWork”类需要覆盖它们。

如果它们没有任何特殊行为，则不需要添加新的 JavaDoc。否则记录他们如何实现抽象方法。通常必须有一个原因为什么这个方法是抽象的，必须在继承类中实现，而不是在抽象类本身中实现。

您可以使用{@inheritDoc}获取继承的 Doumentation 的文本，然后在其下方添加特殊行为。

4 回答 4