讲师中心 微信公众号
AI工具推荐 视频效率加速

Laravel命令行怎么设置命令描述与用法

星墨小哥_1632

星墨小哥_1632

发布时间:2026-08-17 13:05:08

|

570人浏览过

|

来源于php中文网

原创

Laravel通过$description、$help和$signature三个属性支持Artisan命令的描述与用法:$description提供60字内动词开头的简短说明,显示在list中;$help支持换行的详细用法示例,显示在help中;$signature定义参数结构并自动解析为帮助文本。

laravel命令行怎么设置命令描述与用法

命令描述和用法信息是用户发现、理解和正确使用自定义 Artisan 命令的关键。Laravel 通过两个简单属性就能完整支持:一个是面向列表展示的简短描述,另一个是面向终端帮助系统的详细说明。

设置简洁明了的命令描述

在命令类中定义 $description 属性,它会在 php artisan list 输出中显示,用于快速识别命令用途。这个字符串必须是纯文本,不能含 PHP 表达式或变量。

laravel-specialist
laravel-specialist

精通 Laravel 10+,遵循现代 PHP 实践的 Laravel 专家。擅长优雅语法、Eloquent ORM、队列系统及企业级特性...

下载
  • 写法示例:protected $description = '发送每日运营报告给指定用户';
  • 长度建议控制在 60 字以内,避免被截断
  • 动词开头更清晰,比如“发送”“备份”“清理”,而不是“一个用于发送……的命令”

提供完整的命令用法说明

通过 $help 属性补充详细用法,它会在运行 php artisan help your:command 时显示。这里可以包含典型调用示例、参数含义、注意事项等。

  • 写法示例:protected $help = "此命令将生成 PDF 报告并邮件发送。\n\n示例:\n php artisan report:send john --queue\n php artisan report:send --type=daily --when=tomorrow";
  • 支持换行和缩进,但不要用 HTML 或 Markdown 标签
  • 可列出常见组合场景,帮助用户减少试错成本

签名本身也是用法的一部分

$signature 不仅是命令名,还直接定义了参数结构和选项规则,它本身就是最基础的“用法语法”。Laravel 会自动解析并展示在 help 输出里。

  • 例如:protected $signature = 'report:send {user?} {--queue} {--type=weekly}';
  • 执行 php artisan help report:send 后,系统会自动解释:{user?} 是可选参数,{--queue} 是布尔开关,{--type=weekly} 是带默认值的选项
  • 确保签名语义准确,比如必填参数不加 ?,选项等号紧贴名称({--path=} ✅,{--path =} ❌)

热门AI工具

更多
Flowith
Flowith Hot

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

DeepSeek

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

12164

2023.09.01

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

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

6961

2023.10.11

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

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

2215

2023.10.11

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

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

4428

2023.10.23

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

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

5134

2023.10.23

html怎么上传
html怎么上传

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

4031

2023.11.03

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

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

5837

2023.11.09

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

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

4582

2023.11.13

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 221人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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