ApiGen 技术文档

安装指南

使用 Docker 安装

ApiGen 提供了 Docker 镜像，您可以直接使用以下命令进行安装和运行：

docker run --rm --interactive --tty --volume "$PWD:$PWD" --workdir "$PWD" \
  apigen/apigen:edge \
  src --output docs

使用 Phar 安装

您可以通过下载 Phar 文件来安装 ApiGen：

mkdir -p tools
curl -L https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar -o tools/apigen
chmod +x tools/apigen
tools/apigen src --output docs

使用 Composer 安装

通过 Composer 安装 ApiGen：

composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docs

项目的使用说明

生成 API 文档

使用 ApiGen 生成 API 文档非常简单，只需指定源代码目录和输出目录即可：

apigen src --output docs

配置文件

ApiGen 支持通过 apigen.neon 配置文件进行配置。以下是一个示例配置文件：

parameters:
  paths: []
  include: ['*.php']
  exclude: []
  excludeProtected: false
  excludePrivate: true
  excludeTagged: ['internal']
  outputDir: '%workingDir%/api'
  themeDir: null
  title: 'API Documentation'
  baseUrl: ''
  workerCount: 8
  memoryLimit: '512M'

项目API使用文档

命令行参数

• src: 源代码目录。
• --output: 输出目录。
• --include: 包含的文件掩码。
• --exclude: 排除的文件掩码。
• --excludeProtected: 是否排除受保护的成员。
• --excludePrivate: 是否排除私有的成员。
• --excludeTagged: 用于排除类和成员的标签列表。
• --theme: 主题目录。
• --title: 文档标题。
• --base-url: 基础 URL。
• --workers: 并行渲染的进程数。
• --memory-limit: 内存限制。

配置文件参数

• paths: 源代码路径列表。
• include: 包含的文件掩码列表。
• exclude: 排除的文件掩码列表。
• excludeProtected: 是否排除受保护的成员。
• excludePrivate: 是否排除私有的成员。
• excludeTagged: 用于排除类和成员的标签列表。
• outputDir: 输出目录。
• themeDir: 主题目录。
• title: 文档标题。
• baseUrl: 基础 URL。
• workerCount: 并行渲染的进程数。
• memoryLimit: 内存限制。

项目安装方式

ApiGen 提供了三种安装方式：

1. Docker: 使用 Docker 镜像进行安装和运行。
2. Phar: 下载 Phar 文件进行安装。
3. Composer: 通过 Composer 进行安装。

每种安装方式都提供了详细的命令和步骤，用户可以根据自己的需求选择合适的安装方式。