在 phpDoc 语法中定义命名空间
谁能告诉我在 phpDoc 语法中定义 php 命名空间的正确方法是什么?或者,@package 在 phpDoc 中是否已弃用,因为命名空间或多或少定义了一个包?
如果没有,是否有一种通用的方法来记录文档所在的命名空间?
Can anyone tell me what the correct way to define php namespaces in phpDoc syntax is? Or, is @package deprecated in phpDoc, since namespaces more or less define a package?
If there is none, is there a common way to document the namespaces a document is in?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(4)
phpDoc 没有命名空间的概念,但您可以(并且可能应该)使用 @package 。
您可以查看 phplint 文档 以了解它们如何格式化命名空间。
phpDoc doesn't have a concept of namespaces but you can (and probably should) use @package for it.
You might take a look at the phplint documentation to see how they're formatting namespaces.
@package 应该在项目中每个文件的每个文档块中使用,您也可以使用@subpackage。 @package 并未被弃用,并且是定义命名空间的正确方法。
@package Should be used in every docblock of every file in your project, you can also use @subpackage. @package is not deprecated, and would be the correct way to define your namespaces.
你可以看看DocBlox;这是一个支持命名空间的 API 文档生成器。
为了更清楚地回答您的问题:据我遇到的软件包由于命名空间的发明而被视为已弃用。
如果您阅读 PSR-0 规范,您会发现它尝试提供包作为命名空间的第二部分;首先是供应商。
You can take a look at DocBlox; this is a API Documentation Generator that supports namespaces.
And to more clearly answer your question: as far as I have encountered are packages considered Deprecated due to the invention of Namespaces.
If you read the PSR-0 specification you will see that it tries to provide the Package as second part of a namespace; first being vendor.
phpDoc 文档说:
https://www.phpdoc.org/docs/latest/参考文献/phpdoc/tags/package.html
The phpDoc documentation says:
https://www.phpdoc.org/docs/latest/references/phpdoc/tags/package.html