想要在Composer安装后自动生成文档?集成Doxygen/Phpdoc

星明酱_4945

星明酱_4945

2026-06-07

513人浏览

原创

不可行,因composer install仅管理依赖与执行脚本钩子,强行绑定post-install-cmd会导致ci/cd变慢、环境兼容性差及命令路径失效;应通过scripts定义语义化命令(如"docs")手动触发。

想要在composer安装后自动生成文档?集成doxygen/phpdoc

composer install 后自动跑文档生成,基本不可行

因为 composer install 的核心职责是安装依赖、写 autoload、执行脚本钩子(如 post-install-cmd),但它不负责也不适合承担文档生成任务。强行绑定会导致三个实际问题:

  • 每次 composer install 都触发一次完整文档重建,CI/CD 流水线变慢,本地开发也卡顿
  • 文档工具(如 phpdoc 或 doxygen)依赖 PHP 扩展(如 xml、mbstring)、内存足够(常需 -d memory_limit=-1),而部署环境往往不具备这些条件
  • post-install-cmd 在 vendor/ 尚未完全就绪时就执行,容易报 command not found: phpdoc 或路径解析失败

用 scripts 定义语义化命令才是正解

把文档生成当作一个明确的开发操作,而不是安装副作用。在 composer.json 的 scripts 段里加一条干净的命令:

"scripts": {
  "docs": [
    "rm -rf docs/api",
    "php -d memory_limit=-1 vendor/bin/phpdoc --config=phpdoc.xml"
  ],
  "docs:doxygen": "doxygen Doxyfile"
}

这样你只需手动运行:

composer docs —— 调用 phpDocumentor

composer docs:doxygen —— 调用 Doxygen

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

关键点:

  • 命令名用 docs 而不是 generate-docs 或 build-docs,更短、更易记、社区通用
  • 多步骤必须用数组写法,否则 shell 连接符(&&)在 Windows 下会失效
  • php -d memory_limit=-1 显式声明内存限制,避免大项目中途 OOM
  • Doxygen 不走 Composer 管理,得确保系统级已安装且 doxygen 在 $PATH 中

phpdoc.xml 里三处不填对,生成就白跑

phpdocumentor v3 强依赖 phpdoc.xml 配置,但模板里常有坑:

  • <fileset></fileset> 必须包裹 <directory></directory>,单独写 <directory></directory> 会被忽略
  • <directory></directory> 的 path 是相对于 phpdoc.xml 所在位置,不是项目根目录;比如 phpdoc.xml 在根目录,那 path="src" 才对
  • <exclude></exclude> 必须显式列出 Tests、Fixtures、vendor,否则扫描失败或文档混入测试类

示例最小可用片段:

<phpdocumentor><paths><output>docs/api</output></paths><version number="<?php echo json_decode(file_get_contents('composer.json'))->version; ?>"><fileset><directory path="src"></directory><exclude>Tests</exclude><exclude>Fixtures</exclude></fileset></version></phpdocumentor>

Doxygen 和 phpDocumentor 别混着用

两者定位不同,强行共存反而增加维护成本:

  • phpDocumentor:专注 PHP DocBlock,输出结构化 API 文档,支持版本切换、搜索、响应式 UI,适合对外交付
  • Doxygen:跨语言、重注释格式(支持 ///、/**、//!),可导出 LaTeX/PDF,适合内部技术手册或混合语言项目
  • 同一项目同时配两套,composer.json 脚本膨胀、CI 构建时间翻倍、新人搞不清该跑哪个
  • 如果真要双轨,建议用不同命令前缀区隔:docs:api(phpdoc)和 docs:tech(doxygen)

真正容易被忽略的是缓存行为:phpDocumentor v3 默认启用缓存,但缓存路径没显式配置时会落在临时目录,导致二次生成仍扫描全部文件。务必在 phpdoc.xml 中加 <cache><directory>docs/cache</directory></cache>。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11204

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6501

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4108

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4834

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3791

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5437

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4262

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12202

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习