Javadoc {@inheritDoc}标记类

Question

我想使用{@inheritDoc}类继承抽象类中的方法。在抽象类的文档中，我按名称引用了抽象类。我如何标记这个，所以当子类从超类继承文档时，它用子类的名称替换抽象类的名称？

Answer 1

javadoc生成工具不支持您所描述的内容。

我认为这也有一个很好的理由：

如果子类中的方法仅仅是抽象方法的实现，那么我认为将抽象类的名称保留在那里是正确的。

另一方面，如果子类中的方法不仅仅是一个简单的实现，并且做了一些值得注意的事情（足以在javadoc中提到），那么你应该在方法中编写一个新的javadoc。子类，而不是调用inheritDoc。

Answer 2

我不知道某种方法，但您可能会详细说明您希望{@inheritDoc}执行此操作的原因。我可能会误解，但似乎令人困惑。您可以记录具体实现与父项的不同之处，并使用@see来引用抽象类中的契约。注意"Automatic Copying of Method Comments"可能无需明确的{@inheritDoc}。

Answer 3

您也可以在IIRC中在自己的评论中围绕{@inheritDoc}标记撰写其他文字。