Bor*_*ard 25 php phpdoc inheritdoc
如果我只想从父级继承所有文档,那么phpDocumentor中@inheritDoc的正确语法是什么?也许不止一种语法是正确的?
@inheritDoc
{@inheritDoc}
@inheritdoc
{@inheritdoc}
我认为文档很模糊.PhpStorm似乎支持所有这些,但也许我会在使用一些语法生成文档时遇到麻烦?
ash*_*azg 45
子元素应该自动从其父文档块继承几乎所有内容,而不需要此标记.否则,所有的实现方法都必须重新记录,而不需要通过原始接口的文档获得任何内容.
简单地说,没有docblock的继承元素应该自动从其父文档块继承所有内容.
该@inheritdoc
标签的唯一目的是帮助您导入一个从父的docblock件事-父母的详细说明.孩子不应该有这个的唯一原因是孩子继续前进并拥有自己的docblock.现在,孩子应该还是可以继承几乎所有从其父的docblock无需复制它...... 除了父母的详细说明. 如果子docblock由于某种原因选择拥有自己的docblock,并且您仍希望继承父级的Long Description,那么您放入@inheritdoc
子docblock的位置将确定父Long Description的出现位置.因此,孩子可以有自己的简短说明和长说明,仍然还包括其父的长描述,在关系到孩子长描述指定的地点. 这是这个标签诞生的唯一原因 :-)
关于IDE自动完成,我不能说我已经看到IDE在这个标签上的一致行为.此外,我已经看到了一些项目,其中假设这个标记是从父文档块继承信息的原因.