0

我这样命名我的课程:

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我得到这样的打印输出:

在此处输入图像描述

AisisCore_path_to_class 之类的东西不应该在名为 AisisCore 的文件夹中吗我在我的文档中做错了吗?因为老实说,这看起来像一团糟。

4

2 回答 2

0

如果您希望这些东西都属于“AsisCore”,那么您需要对所有内容使用“@package AsisCore”,而不是在包名称中包含子文件夹部分。

无论您使用什么作为“包”名称,都将用于将类组合在一起。通过在包名称字符串中包含这些子文件夹部分,您是在告诉 phpDocumentor 将例如“AsisCore_Template”视为与“AsisCore_Template_Helpers_Loop”分开且无关的东西。

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

于 2013-08-26T14:51:06.563 回答
0

用反斜杠试试。

如:

@package Folder\SubFolder\SubFolder
于 2014-03-23T17:49:45.410 回答