代码之家 › 专栏 › 技术社区 › Kent Boogaart

phpDoc的多个子包

phpdoc php

2

Kent Boogaart · 技术社区 · 17 年前

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

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

谢谢!

3 回复 | 直到 14 年前

1

4

localshred 17 年前

由于名称间距的原因,phpDoc似乎不允许您这样做。从 PHPDoc Docs :

注意:@subpackage标记旨在帮助对实际@package值中的元素进行分类。由于php本身不允许在同一脚本中有两个同名函数,phpdocumentor还要求@package中的所有名称都是唯一的…也就是说,@subpackage不允许在@package中进一步“命名分离”。它所做的是允许对@package中的元素进行一个级别的可视化分组/分离。

似乎是因为phpdoc的@package是一种伪命名函数和类的方法,但是@subpackage只是用于分类。是否尝试添加多个子包?如果是这样,结果如何?

2

E Brent Nelson 14 年前

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

* @package popcap\system\cache

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

3

1

matt 16 年前

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

似乎在多个@subpackage标签上做得很好——它甚至会生成HTML——文档,就像phpdocumentor一样——尽管它看起来不像phpdocumentor那么时尚。

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