command-创建新指令.md 3.5 KB


description: 快速创建新的Roo Code指令,包括标准CRUD指令、自定义指令和常用工作流模板

argument-hint: <指令类型> [实体名称] [模块名称]

创建指令

根据指定的类型和参数快速创建新的Roo Code指令文件。

使用方式

  • /command-create crud User users - 创建用户管理标准CRUD指令
  • /command-create custom complex-report - 创建复杂报表自定义指令
  • /command-create mini-form Login - 创建小程序登录表单指令

指令类型

1. 标准CRUD指令 (crud)

创建包含完整增删改查功能的指令模板

参数:

  • 实体名称 (PascalCase)
  • 模块名称 (snake_case)

示例: /command-create crud Product products

2. 自定义指令 (custom)

创建灵活的自定义业务逻辑指令

参数:

  • 指令名称 (kebab-case)

示例: /command-create custom data-analysis

3. 小程序表单指令 (mini-form)

创建小程序表单页面指令模板

参数:

  • 表单名称 (PascalCase)

示例: /command-create mini-form UserProfile

创建步骤

步骤1: 确定指令类型

根据业务需求选择合适的指令类型:

  • 简单数据管理 → 标准CRUD
  • 复杂业务逻辑 → 自定义指令
  • 小程序页面 → 小程序表单

步骤2: 命名规范

  • 指令文件名使用 功能类别-中文描述.md 格式
  • 功能类别使用英文短横线分隔(如:auth-, check-, generic-crud-, mini-)
  • 中文描述准确反映指令功能
  • 实体名使用 PascalCase
  • 模块名使用 snake_case

步骤3: 选择存放位置

  • 项目特定指令: .roo/commands/
  • 全局通用指令: ~/.roo/commands/

标准CRUD指令模板

创建标准CRUD指令时,将自动生成:

  1. 实体定义文件
  2. Service类
  3. API路由
  4. 前端页面
  5. 客户端API调用

自定义指令模板

创建自定义指令时,提供:

  1. 基础指令框架
  2. 业务逻辑占位
  3. 错误处理模板
  4. 进度跟踪示例

小程序表单指令模板

创建小程序表单指令时,包含:

  1. 表单验证模式
  2. 页面组件结构
  3. 样式规范
  4. 提交处理逻辑

最佳实践

  1. 指令命名: 使用功能类别+中文描述结构,如 auth-认证相关检查, generic-crud-通用开发
  2. 参数设计: 明确指令所需的参数类型和格式
  3. 错误处理: 包含完整的错误处理和用户反馈
  4. 文档说明: 在指令顶部添加清晰的描述和使用示例
  5. 版本管理: 将指令文件纳入版本控制系统

示例指令文件结构

.roo/commands/
├── generic-crud-用户管理开发.md      # 用户管理CRUD
├── custom-月度报表生成.md           # 月度报表生成
├── mini-form-小程序登录表单.md      # 小程序登录表单
└── api-API端点生成器.md            # API端点生成器

快速创建检查清单

  • 确定指令类型和用途
  • 选择合适的命名规范
  • 定义清晰的参数结构
  • 添加详细的描述文档
  • 包含错误处理逻辑
  • 提供使用示例
  • 测试指令功能
  • 更新指令索引

常见问题

Q: 如何创建跨项目的通用指令? A: 将指令文件放在 ~/.roo/commands/ 目录下,所有项目都可访问

Q: 指令参数如何验证? A: 在指令内容中使用正则表达式或条件判断来验证参数格式

Q: 如何共享团队指令? A: 将指令文件提交到项目仓库的 .roo/commands/ 目录,团队成员可同步使用