phpDocumentor 技术文档

1. 安装指南

环境要求

• PHP 8.1 或更高版本。
• 可选：[PlantUml] 用于生成类图。

安装方式

phpDocumentor 提供了四种安装方式：

1. 使用 Phive（推荐）

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

安装后，可以通过以下命令运行：

php tools/phpDocumentor

2. 使用 PHAR（手动安装）

1. 从 GitHub Releases 下载 phar 文件。
2. 执行以下命令运行：

php phpDocumentor.phar

3. 通过 Docker

1. 拉取 Docker 镜像：

$ docker pull phpdoc/phpdoc

2. 运行容器：

$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

4. 通过 Composer（不推荐）

虽然可以通过 Composer 安装，但由于 phpDocumentor 是一个复杂的应用程序，且其库被广泛使用，可能会导致依赖冲突，因此不推荐使用此方式。

2. 项目使用说明

基本使用

最简单的运行方式是使用以下命令：

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

该命令将解析 -d 参数指定的源代码目录，并将生成的文档输出到 -t 参数指定的目标目录。

配置文件

phpDocumentor 支持使用配置文件（默认名为 phpdoc.xml 或 phpdoc.dist.xml）。请参考文档了解配置文件的格式和选项。

命令行选项

可以通过以下命令查看所有可用的命令行选项：

$ phpdoc run -h

3. 项目API使用文档

API 文档生成

phpDocumentor 通过分析 PHP 源代码和 DocBlock 注释，生成完整的 API 文档。它支持以下功能：

• 生成 UML 类图。
• 支持 RestructuredText 和 Markdown 语法。
• 可以将 API 文档部分直接嵌入到 RestructuredText 文档中。

类图生成

如果安装了 [PlantUml]，可以通过以下选项生成类图：

--setting=graphs.enabled=true

4. 项目安装方式

使用 Phive

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

使用 PHAR

1. 下载 phar 文件。
2. 执行：

php phpDocumentor.phar

通过 Docker

1. 拉取镜像：

$ docker pull phpdoc/phpdoc

2. 运行容器：

$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

通过 Composer（不推荐）

不推荐使用 Composer 安装，详见安装指南部分。