phpDocumentor
v3.5.3
phpDocumentor 是 PHP 项目事实上的文档工具，为轻松生成全面的文档提供了强大的解决方案。通过分析您的 PHP 源代码和 DocBlock 注释，phpDocumentor 生成一套完整的 API 文档，使其成为追求清晰且文档齐全的代码库的开发人员不可或缺的工具。
除了 API 文档方面的实力之外，phpDocumentor 还提供了更多功能。它具有创建 UML 图的能力，使其成为可视化代码结构的多功能工具。此外，phpDocumentor 还提供功能齐全的标记语言解析器，支持 RestructedText 和 Markdown 语法。这种灵活性使您可以使用最适合您偏好的标记语言来记录您的项目。
phpDocumentor 的一个显着功能是它能够将部分 API 文档直接包含到 RestructedText 文档中。这种集成可确保您的文档和代码保持同步，从而节省您维护准确和最新的项目文档的时间和精力。
受到其前身 phpDocumentor 1 和 JavaDoc 的启发，phpDocumentor 不断创新，紧跟最新技术和 PHP 语言功能。这一承诺确保开发人员能够获得尽可能最佳的文档体验，并与现代开发实践保持一致。
在本指南中，我们将探讨 phpDocumentor 的各种功能，从生成 API 文档的核心功能到解析标记语言的高级功能。无论您是初学者还是经验丰富的开发人员，phpDocumentor 都是您创建文档齐全、可维护且易于理解的 PHP 项目的盟友。
v3 是最新的稳定版本。
有关更多详细信息，您可以查看我们的在线文档：https://docs.phpdoc.org/。
phpDocumentor 支持以下内容：
兼容 PHP 7.0+ ，提供对命名空间、闭包等的全面支持。
Docblock 优于 types ，docblocks 可以更明确地说明类型，但并非所有格式都受本机 php 支持。
显示任何标签，某些标签为 phpDocumentor 添加附加功能（例如@link）。
内存占用低，小型项目内存占用峰值小于20MB，中型项目40MB，大型框架100MB。
增量解析，如果保留上次运行的结构文件，除了上面提到的处理速度提升之外，您还可以获得高达 80% 的额外性能提升。
简单的模板构建，如果您想制作品牌，您只需调用 1 个任务并编辑 3 个文件。
两步过程，phpDocumentor 首先使用您的应用程序结构生成缓存，然后再创建输出。如果您愿意，您可以使用它来驱动您自己的工具或格式化程序！
泛型支持，随着更多的静态分析，php 类型变得更加复杂。 phpDocumentor 理解这些类型。并将它们呈现为一流类型。
PhpDocumentor 需要 PHP 8.1 或更高版本才能运行。但是，可以分析早期 PHP 版本的代码。
phpDocumentor 提供的所有模板都支持基于读取代码库的类图。这需要在运行 phpDocumentor 的计算机上安装应用程序 [PlantUml]。使用 [PlantUml] 呈现类图是可选的，并且可以忽略有关缺少 [PlantUml] 的警告。但是，在这种情况下，您的文档将包含一些死链接。将使用选项--setting=graphs.enabled=true创建类图。
有4种方式安装phpDocumentor：
使用 phive（推荐）
使用 PHAR（手动安装）
通过码头工人
通过作曲家
$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42
有关 phive 的更多信息，请访问他们的网站。现在你已经安装了 phpDocumentor，它可以像这样执行：
php tools/phpDocumentor
从 https://github.com/phpDocumentor/phpDocumentor/releases 下载 phar 文件
您可以像这样执行 phar： php phpDocumentor.phar
$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc
但是等等？作曲家呢？
啊，你发现了我们的秘密。有一个 phpdocumentor 作曲家包，您可以使用它来安装 phpDocumentor。
然而：phpDocumentor 是一个复杂的应用程序，它的库被用于无数其他库和应用程序（我们的两个库每个都有超过 1.5 亿次下载）；这意味着我们的依赖项之一与您的依赖项之间发生冲突的可能性很高。当我说高时，它真的很高。
因此，由于上述原因：我们不认可也不积极支持使用 Composer 安装 phpDocumentor。
运行 phpDocumentor 最简单的方法是运行以下命令：
$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>
此命令将解析使用-d参数提供的源代码并将其输出到-t参数指示的文件夹。
phpDocumentor 支持一系列选项来配置文档的输出。您可以执行以下命令，或查看我们的网站，以获取可用命令行选项的更详细列表。
$ phpdoc run -h
phpDocumentor 还支持使用配置文件（默认名称为 phpdoc.xml 或 phpdoc.dist.xml）。请查阅文档以查看格式和支持的选项。
PhpDocumentor 没有夜间版本。然而，在每个管道期间都会构建一个 phar 工件。如果您想测试 phpDocumentor 的前沿版本，请查看此存储库的操作部分。每个成功的 QA 工作流程底部都有一个工件部分，其中构建了 phar 工件。
联系我们很容易，可以通过以下方式完成：
推特：@phpDocumentor
网站：https://www.phpdoc.org
GitHub：https://www.github.com/phpDocumentor/phpDocumentor
电子邮件：[email protected]
