PHP如何在DocBlocks中使用@Category标记

Question

有人能解释或举例说明如何正确使用@Category标签吗？PHPDocumentator没有解析标记。

正确的File-DocBlock和Class-DocBlock是什么样子的？

Answer 1

我不知道这有没有帮助，但是...从manual

@category标记用于将多组包组织在一起。这直接适用于XML:DocBook/PEPEDOC2转换器，也可以被其他转换器使用。与phpDocumentor打包的其他转换器会忽略该类别，但这可能会在未来的版本中发生变化。还可以使用-dc命令行开关--defaultcategoryname动态指定类别。

/**
 * Page-Level DocBlock
 * @package MyPackage
 * @category mycategory
 */

/**
 * @global array used for stuff
 */
function mine()
{
    global $baz;
    ...
}

此外，这是一个类别，包括带有@ sample of the proper way to write PEAR code的DocBlocks。

请发布一些不能解析的示例代码--这可能有助于回答问题所在。

Answer 2

关于如何使用@category标签，我还没有找到任何有用的例子。对我来说，使用该标签来表示MVC层是有意义的，例如：

/**
 * Layout or template
 * 
 * @category view
 */

/**
 * Database representation of the user
 * 
 * @category model
 */

/**
 * Login actions
 * 
 * @category controller
 */

我就是这么用的。