Javadoc {@inheritDoc}标签类
我想使用{@inheritDoc}类从我的抽象类inheritance方法。 在抽象类的文档中,我指的是抽象类的名称。 当子类inheritance超类的文档时,如何标记这个名称,用子类名replace抽象类的名字?
你所描述的不是由javadoc生成工具支持的。
我认为这也有一个很好的理由 :
如果你的子类中的方法只是一个抽象方法的实现,那么我认为把抽象类的名字留在那里是正确的。
另一方面,如果你的子类中的方法不仅仅是一个简单的实现,而且做了一些值得注意的事情(足够在javadoc中提到),那么你应该在子类的方法中写一个新的javadoc,而不是调用inheritDoc。
我不知道有什么办法,但是您可以详细说明为什么要{@inheritDoc}
来执行此操作。 我可能会误解,但似乎令人困惑。 你可以logging你的具体实现是如何在父类中变化的,用@see
来指代抽象类中的契约。 注意“ 方法注释的自动复制 ”可能不需要明确的{@inheritDoc}
。
您也可以(IIRC)在您自己的评论中的{@inheritDoc}
标记周围写入其他文本。