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

Question

我想知道如何将@pa​​ckage和@subpackage用于类doc.

假设我有以下课程

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

第一:如果你使用"_"或"\"(命名空间分隔符)不应该影响你的决定,你如何注释你的类.下划线"_"来自命名空间之前的年龄,并且"就像"命名空间分隔符,除了它不创建任何命名空间.所以"My_Controller_Action"应该被视为"My_Controller"中的"Action".

但是,您如何使用@package和/或@subpackage确实是您的决定.例如,我@category根本不使用,并且@subpackage是"第二"命名空间之后的所有内容.让我解释一下:我遵循PSR-0标准,其中包被组织成\<Vendorname>\<packagename>\<subpackage>\...(或"_"而不是"\",具体取决于版本).然后@package <vendorname>.<package>和@subpackage <subpackage>.

结论:由您决定:)文档可能会根据您使用的标记以及如何使用它们来生成代码的不同结构.试一试吧.