java - JavaDoc 中的重写方法

Question

我正在记录我开发的 Java 程序，并且想知道如果我只记录父类(super class)，是否会为继承的方法(被覆盖)生成 JavaDoc？

如果我有一个名为 Vehicle 的类，其中包含 drive() 方法，以及一个名为 Car 的子类，其中包含 drive() 方法被重写，如果 Car 类中没有 Javadoc，Vehicles 驱动方法的文档是否会包含在 Cars 驱动方法中？

Answer 1

[I] wanted to know if JavaDoc will be generated for an inherited method (which is overridden) if I just document the superclass?

是的。如果子类没有 javadoc 注释，则会根据父类(super class) javadoc 生成 javadoc。

如果您在子类中定义 javadocs，它们将替换继承的 javadocs，但您可以使用 {@inheritDoc} 在子类 javadocs 中包含相应的父类(super class) javadoc 注释.

引用:

• https://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#inheritingcomments