phpDocumentor中inheritDoc的正确语法

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

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

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

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

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

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

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


如何选择合适的 C++ Web 开发框架?
利用 C++ 框架构建高并发 Web 应用的策略
用 C++ 框架开发跨平台图形应用程序
golang框架中安全编码实践的最佳指南是什么?
golang框架与其他语言框架在设计理念上的区别有哪些?
C++ 图形框架与其他语言框架的比较
C++ 框架与其他 Web 开发框架的对比分析
使用 C++ 框架构建大型项目最佳实践
C++ 框架如何提高大型项目开发效率
C++ 框架中依赖注入的持续集成与部署工具
如何与社区协作和贡献到自定义 Golang 框架?
C++ 框架在大型项目中如何实现模块化开发
使用 C++ 框架开发跨平台 Web 应用
C++ 框架在大型项目中的优缺点
golang框架在性能上的优势体现在哪些方面?
C++ 框架在嵌入式系统内存优化中的优势
golang框架在人工智能与机器学习中的作用
如何扩展 Golang 框架以支持特定功能?
如何利用 Go Modules 和依赖项管理来自定义 Golang 框架?
Golang 框架中的性能优化技巧