php - phpdoc 的多个子包

Question

一个文件可以属于多个子包吗？例如：

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

谢谢！

Answer 1

由于命名空间的原因，PHPDoc 似乎不允许您这样做。来自PHPDoc 文档：

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

似乎因为 PHPDoc 的 @package 是一种对函数和类进行伪命名空间的方法，但 @subpackage 只是用于分类。您是否尝试过添加多个子包？如果有，结果如何？

Answer 2

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

* @package popcap\system\cache

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

Answer 3

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

使用多个@subpackage 标签似乎做得很好——它甚至会像 phpDocumentor 一样生成 html- 文档——尽管它似乎不像 phpDocumentor 那样具有样式。

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