Composer项目文档：自动生成包含依赖信息的API手册-composer-PHP中文网

composer本身不生成api文档，因其仅负责依赖管理与自动加载，不解析phpdoc注释；需借助phpdocumentor等工具，配合显式配置源码路径、注释规范及缓存优化方可生成。

composer项目文档：自动生成包含依赖信息的api手册

Composer 项目本身不提供 API 文档生成功能，所谓「自动生成包含依赖信息的 API 手册」本质上是混淆了两个独立维度：依赖管理（composer.json / vendor/）和代码级接口文档（如类、方法、参数）。你无法靠 composer install 或 composer dump-autoload 得到类似 Swagger 那样的交互式 API 手册。

为什么 composer 自带命令不生成 API 文档

Composer 是 PHP 的依赖管理器，不是代码分析工具。它的核心职责只有三件事：解析 composer.json、下载包到 vendor/、生成自动加载映射。它不读取 PHPDoc 注释，不解析类结构，也不识别 @param 或 @return —— 这些是 PHPDocumentor、phpstan 或 phpdoc-parser 等工具的工作范围。

composer show 只列出已安装包名和版本，不含任何函数签名或用法说明
composer depends --tree 展示依赖树，但不会告诉你 monolog/monolog 的 Logger::error() 接收什么参数
即使你运行 composer update --with-dependencies，也不会触发任何文档生成逻辑

真正可行的组合方案：PHPDocumentor + composer autoload

要让 API 文档覆盖你自己的代码 + 第三方依赖的公共接口，必须分两步走：先确保所有代码可被扫描（包括 vendor/ 中你想看的包），再用 PHPDocumentor 解析。

Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论（Discussion）”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性，以及撰写结论。当用户输入以下任一指令时也会自动触发该功能： - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载

PHPDocumentor 默认跳过 vendor/ 目录，需显式配置 <directory>vendor/monolog/monolog/src</directory>（注意路径要精确到源码目录，不是 vendor/monolog/monolog）
必须保证目标包含完整 PHPDoc 注释；很多 Composer 包只在发布版删减注释（如只保留 src/，不带 docs/ 或完整 @ 标签），此时生成结果为空白或残缺
推荐用 phpdocumentor run -d src -d vendor/mycompany/internal-sdk/src -t docs/api，避免全扫 vendor/ 导致超时或内存溢出

依赖信息怎么「嵌入」API 手册

PHPDocumentor 本身不渲染依赖关系图，但你可以通过插件或后处理补充。常见做法是：

在 phpdoc.xml 的 <transformations></transformations> 节点里加自定义 XSLT，从 composer.lock 提取版本号注入 HTML 页脚
用脚本解析 composer show --format=json 输出，生成 _includes/dependencies.md，再通过 PHPDocumentor 的 markdown 插件合并进文档站点
如果使用 phpdocumentor/phpdocumentor v3，可启用 graph 插件生成类依赖图，但它仍不展示 Composer 包层级关系

更务实的替代路径：用 OpenAPI + 人工标注

如果你的 Composer 项目实际是个 Web API（如 Laravel、Symfony 或纯 Slim 应用），与其强行把依赖包塞进 API 手册，不如专注描述你暴露的 HTTP 接口：

用 zircote/swagger-php 在控制器方法上写 @OA\Get 注解，执行 swagger-php ./app/Http/Controllers --output docs/openapi.json
搭配 swagger-ui 或 redoc-cli 渲染成网页手册，此时「依赖信息」只需在 README.md 里用 composer show | grep -E '^(laravel|guzzle)' 截图或列表呈现
这种分工更清晰：Composer 管理「用什么」，OpenAPI 描述「怎么调用」，二者不混在一起反而降低维护成本

最常被忽略的一点：PHPDocumentor 对 PHP 8.2+ 的新语法（如 enum、readonly class）支持滞后，若你的项目或所依赖的 SDK 大量使用这些特性，生成的文档可能漏掉关键类型声明——务必在 CI 中加入 phpdoc --validate 检查输出完整性。