phpdoc的多个子包

时间:2008-11-20 19:36:52

标签: php phpdoc

是否可以将文件属于多个子包?例如:

/**
 * Name
 *
 * Desc
 *
 * @package    Core
 * @subpackage  Sub1
 * @subpackage  Sub2
 */

谢谢!

3 个答案:

答案 0 :(得分:4)

似乎PHPDoc不允许您为命名空间原因执行此操作。来自PHPDoc Docs

  

注意:@subpackage标记旨在帮助对实际@package值中的元素进行分类。由于PHP本身不允许在同一个脚本中使用两个具有相同名称的函数,因此PhpDocumentor还要求@package中的所有名称都是唯一的...意思是,@ subpackage不允许在其中进一步“命名分离” @包。它所做的是允许对@package内的元素进行一定程度的可视分组/分离。

似乎因为PHPDoc的@package是一种伪命名空间函数和类的方法,但@subpackage只是用于分类。您是否尝试过添加多个子包?如果是的话,结果是什么?

答案 1 :(得分:2)

您可以使用以下方法执行此操作:

* @package popcap\system\cache

这将在您编译PHPdocs时创建包的层次结构。

答案 2 :(得分:1)

http://pear.php.net/package/PHP_UML/

似乎用多个@subpackage标签做得很好 - 它甚至会像phpDocumentor一样生成html文档 - 虽然它看起来不像phpDocumentor那样样式。

它还通过在生成的UML diagaram中显示它来利用额外的子包。