我们应该使用JavaDoc类扩展抽象类吗?

我们应该使用JavaDoc类扩展抽象类吗?,java,javadoc,Java,Javadoc,假设我正在编写一个类“MyWork”,扩展抽象类“Work”。现在,假设我在“MyWork”中需要的所有方法都已经声明,并且它们的JavaDoc都是用“Work”编写的。我还应该在“MyWork”中添加JavaDoc吗 干杯 除非MyWork中的方法覆盖Work中的任何功能,否则可以安全地假定这些方法的行为与其超类类似。不应该有任何理由记录未重写的方法或字段。我假设您讨论的是抽象方法,因此“MyWork”类需要重写它们 如果它们没有任何特殊行为,则不需要添加新的JavaDoc。通常,这个方法是抽

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


干杯

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

我假设您讨论的是抽象方法,因此“MyWork”类需要重写它们

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


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

这取决于具体情况。如果您没有重写任何方法,那么就没有添加Javadoc的选项(仅在类级别)。向类中添加一些Javadoc来解释它存在的原因是有意义的

如果要重写方法,可以这样编写Javadoc:

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

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