0

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

这是我现在的课程的屏幕截图：

在此处输入图像描述

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

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

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

我可以在 phpdoc.dist.xml 中解决这个问题还是需要创建一个新模板？

任何建议将不胜感激！

编辑：这是一个示例文档块：

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

2 回答 2

1

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

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

于 2013-11-01T16:34:03.897 回答
0

对不起，我的英语不好

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

@package正如他们在PHPDocumentator 的文档中所说， @ashnaz 在课堂评论中使用的解决方案在左侧菜单中不起作用，但确实在右侧菜单中显示了包！

经过数小时的搜索，我找到了如何在左侧菜单中对课程进行分组！

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

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

    • 要将类组合在一起，它们需要具有相同的名称空间。
    • 你可以有多个命名空间！

  • 命名空间行必须是页面中的第一行代码！所以<?php直接下线！课程的开头应该是这样的：

    <?php 
namespace GroupName;

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

于 2019-06-21T17:15:40.513 回答