phpDocumentor中inheritDoc的正确语法

前端之家收集整理的这篇文章主要介绍了phpDocumentor中inheritDoc的正确语法前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
PHPDocumentor中@inheritDoc的正确语法是什么,如果我只想从父代继承所有的文档?也许多个语法是正确的?

> @inheritDoc
> {@inheritDoc}
> @inheritdoc
> {@inheritdoc}

文件很模糊,我想. PHPStorm似乎支持所有这些,但也许我会用一些语法生成文档有困难?

子元素应该自动从其父文档块自动继承所有内容,而不需要此标签.否则,所有的实现方法都必须被记录在一起,而不会被原始界面的文档所取代.

简单来说,没有docblock的继承元素应该自动从其父代的docblock继承所有内容.

@inheritdoc标签的唯一目的是帮助您从父文档块(父级的长描述)导入一件事.孩子不应该有这个可用的唯一原因是如果孩子继续前进并拥有自己的docblock.现在,孩子应该继承几乎所有的东西从父母的docblock而不必复制它除了父母的长说明.如果由于某种原因,小孩docblock选择了自己的docblock,并且您仍然希望继承父长期描述,那么将@inheritdoc放在子文档块中的位置就决定了父长期描述的出现位置.因此,孩子可以有自己的简短描述和长描述,并且还将其父母的长描述包含在与孩子长描述相关的指定位置.这是这个标签诞生的唯一原因:-)

关于IDE自动完成,我不能说,当涉及到这个标签时,我已经看到了IDE中的一致行为.此外,我看到的项目是假设这个标签是继承的父文档块信息甚至发生的原因.

原文链接:https://www.f2er.com/php/139997.html

猜你在找的PHP相关文章