如果方法实现的接口具有 JavaDoc 注释，那么实现方法是否应该具有 JavaDoc 注释

Question

假设我有一个如下界面。

public interface MyInterface{

 /**
 * This method prints hello
 */
  void sayHello();

  /**
  * This method prints goodbye
  */
  void sayGoodBye();
}

具体的类实现这些方法。现在，具体类中的方法是否还需要在其方法定义之上定义 javadoc？我看到有些人只是将相同的 javadoc 定义复制到具体类的实现方法中。我不认为这是一个好的做法，因为如果我们要更改文档定义，我们需要在多个地方更改它。

标准做法是什么？

Answer 1

您可以使用{@inheritDoc}继承接口的文档，如果您认为额外的注释对于特定实现来说是重要且相关的额外信息，则只需添加额外的注释即可。

仅当您打算添加到原始超类/接口文档时才使用@inheritDoc。如果您只想要一个副本，Javadoc 会处理这个问题。它将看到超类文档适用于子类的重写方法，因为子类没有提供附加文档。

{@inheritDoc}- 将文档从“最近的”可继承类或可实现接口继承（复制）到此标记位置的当前文档注释中。这允许您在继承树的较高位置编写更一般的注释，并在复制的文本周围编写。

http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#@inheritDoc