在PhpDocumentor 2中使用@package而不是命名空间

时间:2014-03-06 19:13:08

标签: php namespaces phpdoc docblocks phpdocumentor2

我有一个大型代码库,我正在尝试生成分层文档。该项目不使用名称空间,而是使用@package。

我刚尝试使用phpDocumentor2从以下文件生成文档作为测试:

<?php
/**
 * This is a file
 * @package JustAn\Example
 **/

 /**
 * Something class
 **/
 class Something{
    function try_this(){

    }
 }

虽然根据文档@package JustAn \ Example应该等同于命名空间JustAn \ Example,但我发现情况并非如此。

当我使用命名空间时,生成的文档是这样的:

namespace version

当我使用@package表示法时,结果看起来像这样(即使它识别包符号 - 这显示在类的完整详细信息页面上):

package notation version

我正在寻找一种获取分层结果的方法,而无需重写代码以使用“真正的”命名空间。

2 个答案:

答案 0 :(得分:4)

问题是默认的“干净”模板不支持此功能。其他模板(例如“响应”)可以。您可以使用--template =“responsive”标志来更改使用的默认模板。

答案 1 :(得分:0)

我发现您在文件 docblock中有包标记,但 docblock没有。如果你把它添加到你的类docblock中,我认为它应该可行。