讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

Composer 怎么给命令参数加注释说明

老墨同学_9325

老墨同学_9325

发布时间:2026-11-12 09:21:21

|

633人浏览过

|

来源于php中文网

原创

Composer 原生不支持在 composer run --list 中显示自定义脚本说明,此功能直至 Composer 2.5 才通过 scripts-descriptions 字段实现;该字段需与 scripts 同级,键名严格匹配且仅对非生命周期脚本生效。

composer 怎么给命令参数加注释说明

composer run --list 不显示脚本说明是正常行为

Composer 原生不支持为自定义脚本(如 "dev:setup")在 composer run --list 中显示帮助文本。这不是配置写错了,而是功能上就不存在——直到 Composer 2.5 才通过 scripts-descriptions 字段补上这一环。

用 scripts-descriptions 添加简短说明(仅 Composer 2.5+)

该字段必须与 scripts 同级,键名严格匹配脚本名,且只对非生命周期钩子生效(post-install-cmd 这类无效):

{
    "scripts": {
        "dev:setup": ["composer install", "php generate-config.php"],
        "clear-cache": ["php clear-cache.php"]
    },
    "scripts-descriptions": {
        "dev:setup": "初始化开发环境:装依赖 + 生成配置",
        "clear-cache": "清空应用缓存目录"
    }
}
  • scripts-descriptions 的值只是纯文本,不支持 Markdown 或换行
  • 键名大小写敏感,"Dev:setup" 和 "dev:setup" 不等价
  • 旧版 Composer(

兼容所有版本的可靠方案:脚本内处理 --help

在 PHP 脚本开头手动解析 --help 或 -h 参数,是最稳妥的做法:

Academic Composer Upload
Academic Composer Upload

辅助学术写作,包括查找资料、生成大纲、引用扩写及润色风格,同时确保引用规范。

下载
#!/usr/bin/env php
<?php
if (in_array('--help', $argv) || in_array('-h', $argv)) {
    echo "Usage: composer run dev:setup\n";
    echo "       composer run dev:setup -- --force\n\n";
    echo "Options:\n";
    echo "  --force    跳过确认,强制重写配置\n";
    exit(0);
}
<p>require <strong>DIR</strong> . '/vendor/autoload.php';
// …后续逻辑</p>
  • 注意 composer run dev:setup -- --force 中的双横线 -- 是分隔符,用于把参数透传给脚本
  • 脚本里不能只依赖 $argv[1],因为 composer run 会往前面加一堆内部参数
  • 这种写法不依赖 Composer 版本,CI/CD 和本地开发表现一致

别把 description 当帮助文档用

description 字段只用于 Packagist 页面摘要展示,会被截断(通常只显示前 120 字),且不参与任何命令行交互:

  • 它不会出现在 composer run --list 输出里
  • 填长文本没意义,填安装步骤更误导用户
  • 真正要暴露给使用者的操作入口,应落在 scripts 名称本身(比如 test、build、serve)和配套的 --help 实现上

脚本的帮助信息容易被当成“锦上添花”,但实际是协作链路里最常被查阅的一环——漏掉它,别人第一次运行时就得去翻源码或 git log。

热门AI工具

更多
函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

364

2023.12.25

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

623

2026.04.10

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

367

2026.04.10

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

389

2026.04.10

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

340

2026.04.13

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

563

2026.04.13

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

351

2026.04.14

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

430

2026.04.14

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

80

2026.11.06

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn