phpDocumentor 中 inheritDoc 的正确语法

2022-08-30 11:53:58

如果我只想从父级继承所有文档,phpDocumentor 中@inheritDoc的正确语法是什么?也许多个语法是正确的?

  1. @inheritDoc
  2. {@inheritDoc}
  3. @inheritdoc
  4. {@inheritdoc}

我认为文档非常模糊。PhpStorm似乎支持所有这些,但也许我在使用某些语法生成文档时会遇到麻烦?


答案 1

子元素应该自动从其父文档块继承几乎所有内容,而无需此标记。否则,您的所有实现方法都必须重新记录,而不会通过原始接口的文档获得任何东西。

简单地说,没有文档块的继承元素应该自动从其父级的文档块继承所有内容

该代码的唯一目的是帮助您从父文档块导入个东西 - 该父级的长描述。孩子不应该已经拥有这个的唯一原因是如果孩子继续并拥有自己的文档块。现在,孩子仍然应该从其父文档块继承几乎所有内容,而不必复制它......除了父级的“详细描述”。如果子文档块出于某种原因选择拥有自己的文档块,并且您仍然希望继承父级的“详细描述”,则您放入子文档块的位置将决定该父级“详细描述”的显示位置。因此,子级可以有自己的“简短描述”和“详细描述”,并且仍然将其父级的“长描述”包含在与子“详细描述”相关的指定位置。这是这个标签诞生的唯一原因:-)@inheritdoc@inheritdoc

关于IDE自动完成,我不能说我已经看到IDE中关于这个标签的一致行为。此外,我见过一些项目,其中假设此标记是甚至发生从父文档块继承信息的原因


答案 2

我对IDE支持一无所知,但文档将其拼写为.{@inheritDoc}


推荐