如果我只想从父级继承所有文档,那么在phpDocumentor中@inheritDoc的正确语法是什么?也许不止一个语法是正确的?
@inheritDoc
{@inheritDoc}
@inheritdoc
{@inheritdoc}
我认为文档相当模糊。PhpStorm似乎支持所有这些语法,但也许我在使用某些语法生成文档时会遇到问题?
发布于 2014-10-25 02:43:11
子元素应该自动继承它的父docblock中的几乎所有内容,而不需要这个标记。否则,您的所有实现方法都必须重新记录,而不能从原始接口的文档中获得任何东西。
简单地说,没有docblock 的继承元素应该自动从其父元素的docblock继承所有内容。
@inheritdoc
标记的唯一目的是帮助您从父文档块导入one内容--父文档块的详细描述。孩子不应该已经拥有它的唯一原因是如果孩子继续使用它自己的docblock。现在,子对象应该仍然继承它的父docblock中的几乎所有内容,而不必复制它……除外的父级的详细描述。如果子文档块出于某种原因选择拥有自己的文档块,而您仍然希望继承父文档块的详细描述,那么在子文档块中放置@inheritdoc
的位置将决定父文档块的详细描述出现的位置。因此,子代可以有它自己的短描述和长描述,并且仍然在与子代长描述相关的指定位置中包括它的父代的长描述。这是这个标签诞生的唯一原因 :-)
关于IDE自动完成,我不能说当涉及到这个标记时,我在IDE中看到了一致的行为。此外,我还看到过一些项目,假设这个标记是从父docblocks继承信息的发生的原因。
发布于 2017-03-25 20:48:22
我对集成开发环境的支持一无所知,但documentation将其拼写为{@inheritDoc}
。
https://stackoverflow.com/questions/26550745
复制相似问题