我想使用{@inheritDoc}该类从我的抽象类继承方法。在抽象类的文档中，我按名称引用抽象类。我如何标记它，以便当子类从超类继承文档时，它将抽象类的名称替换为子类的名称？
问问题
77774 次
3 回答
46
javadoc 生成工具不支持您所描述的内容。
我认为这也是有充分理由的：
如果您在子类中的方法仅仅是抽象方法的实现，那么我认为将抽象类的名称留在那里是正确的。
另一方面，如果您在子类中的方法不仅仅是一个简单的实现，并且做了更多值得注意的事情（足以在 javadoc 中提到），那么您应该在子类中的方法上编写一个新的 javadoc，而不是调用inheritDoc。
于 2010-01-30T05:40:24.673 回答
17
我不知道有什么方法，但是您可能会详细说明为什么{@inheritDoc}要这样做。我可能会误解，但似乎令人困惑。您可以记录您的具体实现如何与父级不同，并用于@see引用抽象类中的合同。注意“方法注释的自动复制”可能不需要显式的{@inheritDoc}.
于 2010-01-30T04:04:51.580 回答
0
IIRC，您还可以{@inheritDoc}在自己的评论中在标签周围写下额外的文本。
于 2013-01-14T15:34:02.670 回答