PHPDoc没有显示包的文件夹?

时间:2013-08-25 19:26:44

标签: php documentation phpdoc

我将我的课程命名为:

Folder_SubFolder_SubFolder_ClassName{}

众所周知,创建一个文件夹目录:Folder/SubFolder/SubFolder/ClassName.php

现在我这样记录这个类:

/**
 * Some title
 *
 * Some Description
 *
 * @package Folder_SubFolder_SubFolder
 */
Folder_SubFolder_SubFolder_ClassName{}

现在我使用http://www.phpdoc.org/,当我运行时:$ phpdoc -d . -t docs我打印出这样的内容:

enter image description here

像AisisCore_ path_to_class 这样的东西不应该在名为AisisCore的文件夹中吗?我在文档中做错了吗?老实说,这看起来很乱。

2 个答案:

答案 0 :(得分:0)

如果你希望这些东西都属于“AsisCore”,那么你需要使用“@package AsisCore”作为一切,而不是在包名中包含Subfolder部分。

无论您使用什么作为“包”名称,都将用于将类组合在一起。通过在包名称字符串中包含这些子文件夹片段,您告诉phpDocumentor将“AsisCore_Template”视为与“AsisCore_Template_Helpers_Loop”无关且与其无关的内容。

查看输出列表,我可能会选择在程序包名称中包含零或最多一个,子文件夹级别。然后,当您查看一个包的主页面时,您会看到类名本身有助于按列表顺序将事物组合在一起,这只是因为您遵循PSR-0 / PEAR命名约定。

答案 1 :(得分:0)

使用反斜杠尝试。

如:

@package Folder\SubFolder\SubFolder