代码之家  ›  专栏  ›  技术社区  ›  LandonSchropp

javadoc@inheritDoc标记类

  •  40
  • LandonSchropp  · 技术社区  · 14 年前

    我想用 {@inheritDoc} 类从抽象类继承方法。在抽象类的文档中,我按名称引用了抽象类。我如何标记它,以便当子类从父类继承文档时,它用子类的名称替换抽象类的名称?

    3 回复  |  直到 7 年前
        1
  •  44
  •   aweigold    11 年前

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

    我认为 好理由 对于这一点:

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

    另一方面,如果子类中的方法不仅仅是一个简单的实现,而且做了一些值得注意的事情(足够在JavaDoc中提到),那么您应该在子类中的方法上编写一个新的JavaDoc,而不是调用InheritDoc。

        2
  •  15
  •   trashgod    14 年前

    我不知道有什么办法,但你可以详细说明你为什么要 {@inheritDoc} 这样做。我可能会误解,但这似乎令人困惑。您可以记录具体实现与父级的差异并使用 @see 在抽象类中引用合同。注意 " Automatic Copying of Method Comments " 可以不需要一个明确的 {@继承文件} .

        3
  •  0
  •   Ti Strga    11 年前

    你也可以,iirc,在 {@inheritDoc} 加入你自己的评论。