如何编写一个composer脚本来自动生成文档-composer-PHP中文网

如何编写一个composer脚本来自动生成文档

下次还敢

发布： 2025-09-29 14:14:02

原创

830人浏览过

答案：通过 Composer 的 scripts 功能可自动化生成文档，首先安装 phpDocumentor，再创建生成脚本并配置 composer.json 中的 docs、post-install-cmd 和 post-update-cmd 命令，实现手动或自动触发文档生成，还可使用 phpdoc.xml 配置文件自定义输出。

如何编写一个composer脚本来自动生成文档

编写一个 Composer 脚本来自动生成文档，关键是利用 Composer 的 scripts 功能，在执行命令时触发自定义的 PHP 或 shell 脚本。下面是一个实用的实现流程。

1. 确定文档生成工具

常见的 PHP 文档生成工具包括：

phpDocumentor：功能强大，支持标准 DocBlock 注释
Doxygen（跨语言）
ApiGen（已停止维护，不推荐）

这里以 phpDocumentor 为例，通过 Composer 安装：

composer require --dev phpdocumentor/phpdocumentor

2. 创建文档生成脚本

你可以写一个简单的 PHP 脚本或 shell 命令来调用 phpDocumentor。更灵活的方式是使用 Composer 的 scripts 直接调用 vendor/bin 中的可执行文件。

也可以创建一个自定义 PHP 脚本，例如：scripts/generate-docs.php

<?php
// scripts/generate-docs.php
echo "Generating documentation...\n";
$command = 'vendor/bin/phpdoc run -d src -t docs';
$result = system($command, $returnCode);

if ($returnCode !== 0) {
echo "Documentation generation failed.\n";
exit(1);
}
echo "Documentation generated in /docs\n";

3. 配置 composer.json 的 scripts

在 composer.json 中添加自定义脚本：

东盟商机最新AC版As2007 SP1

AS系统本次的主要更新和新开发的功能如下（暂不详述）： 1、修复了普及版的一些大大小小的BUG 2、重新规划整个后台，使后台更加个性化、智能化、更加易用 3、重写了广告部分模块，使其更加专业化 4、重写了文章采集模块，添加了定时自动采集功能 5、添加了供求信息采集功能 6、重写了友情连接功能（原来的太简单了） 8、重写了生成HTML模块。（几个主要模块首页不用原来的生成方式，不再会被卡巴斯机杀毒软

查看详情

"scripts": {
  "docs": ["php scripts/generate-docs.php"],
  "post-update-cmd": ["@docs"],
  "post-install-cmd": ["@docs"]
}

这样配置后，运行以下命令都会触发文档生成：

composer docs：手动执行文档生成
composer install 或 update 后自动执行

4. 可选：添加配置文件提升灵活性

你可以在项目根目录添加 phpdoc.xml 来定制输出：

<?xml version="1.0" encoding="UTF-8"?>
<phpdocumentor>
<paths>
<path source="src" target="docs"/>;
</paths>
<title>My Project Docs</title>
</phpdocumentor>

然后修改脚本中的命令为：
vendor/bin/phpdoc run -c phpdoc.xml

基本上就这些。通过组合 Composer scripts 和文档工具，可以轻松实现自动化文档生成，尤其适合在开发流程或 CI/CD 中集成。

以上就是如何编写一个composer脚本来自动生成文档的详细内容，更多请关注php中文网其它相关文章！