Javadoc {@inheritDoc} tag class

java inheritdoc javadoc

2022-09-01 02:05:02

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

答案 1

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

我认为这也是有充分理由的：

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

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

答案 2

我不知道有什么办法，但你可能会详细说明为什么你想要{@inheritDoc}这样做。我可能误解了，但似乎令人困惑。您可以记录您的具体实现如何从父级变化，并使用@see来引用抽象类中的协定。注意“自动复制方法注释”可以避免显式 {@inheritDoc} 的需要。