在PHPDocumentor中组织文件

Question

我最近安装了PHPDocumentator 2并且喜欢它到目前为止。我想做的一件事是以更有意义的方式组织文件（特别是使用实际的文件夹结构）并按字母顺序排列。

以下是我的课程的截图：

请注意，它们根本不是按字母顺序排列的。实际的文件夹结构如下：

system/
  - Database
  - all Form classes
  - Tester
extra/
  - Registration
  - ConfigForm

我没有使用名称空间，但我在所有类上都有@ package。

我可以在phpdoc.dist.xml中修复此问题，还是需要创建新模板？

非常感谢任何建议！

修改：以下是docBlock示例：

/**
  * FormElement Class
  *
  * @category System
  * @package  Form
  */
abstract class FormElement
{

Answer 1

在对phpDocumentor 2.1.0提供的各种输出模板进行采样时，我发现有些模板按字母顺序排列左侧列表，而其他模板则没有。即使可能，那些不按字母顺序排列列表的人也可能是这些模板中的错误。

关于您通过@package进行的组织，您的期望是正确的。但是，我在您的图像中看到您显示的是“\”全局命名空间列表而不是Packages列表。您将要根据它显示“包”视图的方式选择模板。我建议先尝试抽象模板，看看它是否符合你的喜好。我看到它按字母顺序列出了包的列表，以及它在包中的类列表。

Answer 2

  

对不起，我的英语不好

我有同样的问题（也有PHPDocumentator 2）！

The solution of @ashnaz，在班级注释中使用@package，就像他们在the documentation of PHPDocumentator中所说的那样：在左侧菜单中不起作用，但确实显示了该软件包在右侧菜单中！

经过数小时的搜索，我发现了如何在左侧菜单中对班级进行分组！

在文档中所需的所有文件中，添加一个命名空间。就我而言，名称空间的名称是我的类所在的文件夹/目录。但是您可以使用所需的名称对类进行分组！所以这里是解决方案：

• 在要分组在一起的所有类中添加名称空间

  • 要将类分组，他们需要具有相同的命名空间
  • 您可以有多个名称空间！

• 名称空间行必须为页面中的第一行代码！因此，直接在<?php行下！该课程的开始应如下所示：

  <?php 
  namespace GroupName;
  

  并运行您的phpdoc命令（我使用phpdoc -m --validate --force），您应该具有结构的左侧菜单。