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

Question

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

干杯！

Answer 1

这取决于。如果您没有覆盖任何方法，则无法添加Javadoc（仅限于类级别）。将一些Javadoc添加到类中解释其存在的原因是有意义的。

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

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

Answer 2

对于非公开代码，我不会打扰@inheritDoc无法处理的任何内容。

Answer 3

除非MyWork中的方法覆盖Work中的任何功能，否则可以安全地假设这些方法的行为类似于它们的超类。没有任何理由记录未覆盖的方法或字段。

Answer 4

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

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

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