[译] 使用 Sami 生成 PHP 文档

Sami 是一个用于生成 PHP 文档的工具。它可以帮助开发者自动生成 API 文档，使其更易于阅读和理解。

以下是使用 Sami 生成 PHP 文档的步骤：

1. 安装 Sami：首先，你需要在你的项目中安装 Sami。你可以通过 Composer 来安装 Sami。在你的项目根目录下创建一个 composer.json 文件，并添加以下内容：

{
    "require-dev": {
        "sami/sami": "^6.0"
    }
}

然后，在命令行中运行 composer install 命令来安装 Sami。

2. 创建 Sami 配置文件：在你的项目根目录下创建一个名为 sami.php 的文件，并添加以下内容：

<?php

use Sami\Sami;
use Symfony\Component\Finder\Finder;

$iterator = Finder::create()
    ->files()
    ->name('*.php')
    ->in('path/to/your/source/files');

return new Sami($iterator, [
    'title' => 'Your Project Name',
    'build_dir' => 'path/to/output/directory',
    'cache_dir' => 'path/to/cache/directory',
]);

在这个配置文件中，你需要指定你的源代码文件所在的路径、生成文档的输出目录以及缓存目录。

3. 生成文档：在命令行中运行以下命令来生成文档：

php sami.php update path/to/sami.php

这将根据配置文件中的设置生成文档，并将其保存到输出目录中。

4. 查看文档：一旦文档生成成功，你可以在浏览器中打开生成的文档文件来查看它们。

以上就是使用 Sami 生成 PHP 文档的基本步骤。你可以根据自己的需求来调整配置文件中的设置，以满足你的文档生成需求。