在phpDocumentor中更正inheritDoc的语法

时间:2014-10-24 15:05:45

标签: php phpdoc inheritdoc

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

  1. @inheritDoc
  2. {@inheritDoc}
  3. @inheritdoc
  4. {@inheritdoc}
  5. 我认为文档很模糊。 PhpStorm似乎支持所有这些,但也许我在使用某些语法生成文档时遇到了麻烦?

2 个答案:

答案 0 :(得分:42)

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

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

@inheritdoc标记的唯一目的是帮助您从父文档块导入一个 - 该父级的长描述。孩子不应该有这个的唯一原因是孩子继续前进并拥有自己的docblock。现在,孩子仍然从其父文档块继承几乎所有内容而不必复制它... 除了父级的长描述。 如果子docblock由于某种原因选择拥有自己的docblock,仍然想要继承父级的长描述,那么你放在哪里子docblock中的@inheritdoc确定父长描述出现的位置。因此,孩子可以拥有自己的简短描述和长描述,并且仍然将其父级的长描述包含在与子长描述相关的指定位置。 这是此标签诞生的唯一原因: - )

关于IDE自动完成,我不能说我已经看到IDE在这个标签上的一致行为。此外,我已经看到了一些项目,假设这个标签是继承父文档块信息的原因

答案 1 :(得分:2)

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