在phpDoc语法中定义名称空间

时间:2011-01-13 19:19:33

标签: php phpdoc

谁能告诉我在phpDoc语法中定义php命名空间的正确方法是什么?或者,@ package在phpDoc中是否已弃用,因为名称空间或多或少地定义了一个包?

如果没有,是否有一种通用的方法来记录文档所在的命名空间?

4 个答案:

答案 0 :(得分:7)

phpDoc没有命名空间的概念,但您可以(也可能应该)使用@package。

您可以查看phplint documentation以了解它们如何格式化命名空间。

答案 1 :(得分:2)

@package应该在项目中每个文件的每个docblock中使用,也可以使用@subpackage。 @package不会被弃用,并且是定义命名空间的正确方法。

答案 2 :(得分:1)

你可以看看DocBlox;这是一个支持命名空间的API文档生成器。

更清楚地回答你的问题:据我所知,由于命名空间的发明而被认为是不推荐使用的包。 如果您阅读PSR-0规范,您将看到它尝试将Package作为命名空间的第二部分提供;首先是供应商。

答案 3 :(得分:0)

phpDoc文档说:

  

@package标签可以用作对应物或补充物   命名空间。命名空间提供了Structural的功能细分   @package标记可以提供逻辑细分的元素   哪种方式可以将元素分组为不同的层次结构。

     

如果全面,逻辑和功能细分都是如此   等于不推荐使用@package标签来防止   维护费用。

https://www.phpdoc.org/docs/latest/references/phpdoc/tags/package.html