【发布时间】:2014-04-09 15:19:27
【问题描述】:
我有一个大型代码库,我正在尝试为其生成分层文档。该项目不使用命名空间,而是使用@package。
我刚刚尝试使用 phpDocumentor2 从以下文件生成文档作为测试:
<?php
/**
* This is a file
* @package JustAn\Example
**/
/**
* Something class
**/
class Something{
function try_this(){
}
}
虽然根据文档@package JustAn\Example 应该等同于命名空间 JustAn\Example,但我发现情况并非如此。
当我使用命名空间时,生成的文档是这样的:
当我使用@package 表示法时,结果如下所示(即使它识别包表示法 - 这显示在类的完整详细信息页面上):
我正在寻找一种方法来获得分层结果,而无需重写代码以使用“真实”命名空间。
【问题讨论】:
-
目前@package 似乎确实存在问题。见github.com/phpDocumentor/phpDocumentor2/issues/1133
-
这似乎是无关的,因为 @package 标签已注册,它只是不会导致相同的层次列表。我为它创建了一个问题:github.com/phpDocumentor/phpDocumentor2/issues/1155
标签: php namespaces phpdoc docblocks phpdocumentor2