php - 如何在phpdoc中使用@package和@subpackage？

Question

我想知道我应该如何将@pa​​ckage 和@subpackage 用于类文档。

假设我有以下类(class)

class My_Controller_Action_Helper_MyHelperAction extends Foo_Bar {}

应该是:

@category    My
@package     Controller
@subpackage  Action_Helper

或

@category    My
@package     Controller
@subpackage  Action_Helper_MyHelperAction

或

@category    My
@package     Controller_Action
@subpackage  MyHelperAction

或

@category   My
@package    My_Controller_Action
@subpackage MyHelperAction

如果使用命名空间而不是“_”呢？

Answer 1

首先:如果您使用“_”或“\”( namespace 分隔符)，应该不会影响您的决定，以及您如何注释您的类。下划线“_”来自前命名空间时代，“作用类似于”命名空间分隔符，只是它不创建任何命名空间。所以“My_Controller_Action”应该被视为“My_Controller”中的“Action”。

但是，你怎么用@package和/或 @subpackage真的是你的决定。例如我不使用 @category完全和@subpackage是“第二个”命名空间之后的所有内容。让我解释一下:我遵循 PSR-0 标准，其中一个包的结构为 \<Vendorname>\<packagename>\<subpackage>\... (或“_”而不是“\”，具体取决于版本)。那么@package <vendorname>.<package>和 @subpackage <subpackage> .

结论:由您决定 :) 文档编写者可能会生成不同的代码结构，具体取决于您使用的标签和使用方式。试试吧。