在JavaDoc中重写的方法

我logging了我开发的一个Java程序，并且想知道如果我只是logging超类，JavaDoc是否将为inheritance的方法（被重写）生成？

如果我有一个名为Vehicle带有drive()方法的类drive()和一个名为Car且具有重写的drive()方法的子类，那么如果没有放入Javadoc，则将车辆驱动方法的文档包含在Cars驱动器方法中在汽车类？

Answer 1

[我]想知道如果JavaDoc将被生成的inheritance的方法（这是重写），如果我只是文档的超类？

是。 如果你的子类没有javadoc注释，javadocs将会根据超类javadoc生成。

如果在子类中定义了javadoc，它们将replaceinheritance的javadoc，但是可以使用{@inheritDoc}将相应的超类javadoc注释包含在子类javadoc中。

参考：

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

Answer 2

如果要使用重写方法的JavaDoc，请使用{@inheritDoc} 。 F. e。 ：

 /** * {@inheritDoc} */ @Override public double getX() { ... } 

请注意，几乎所有的重写方法也inheritance了上层文档:)。 你可以在oracle文档中看到它（感谢提示@Steve Kuo）。

在以下两种情况下，Javadoc工具能够在类和接口中复制或“inheritance”方法注释。 构造函数，字段和嵌套类不会inheritancedoc注释…（1）自动inheritance注释以填充缺失的文本…（2）使用{@inheritDoc}标签显式inheritance注释

使用@see如果你想引用一个类似/重要/ …的方法。 java.awt.Point类的示例：

  /** * Returns the location of this point. * This method is included for completeness, to parallel the * <code>getLocation</code> method of <code>Component</code>. * @return a copy of this point, at the same location * @see java.awt.Component#getLocation * @see java.awt.Point#setLocation(java.awt.Point) * @see java.awt.Point#setLocation(int, int) * @since 1.1 */ public Point getLocation() { ... }