跳到主要内容

掌握 Cursor MDC 规则：最佳实践和故障排除指南

本指南将帮助您了解如何有效使用 Cursor 的 MDC（Model-Driven Code）规则，提高代码质量和开发效率。

MDC 规则概述​

MDC 规则是配置文件，用于：

  • 定义 AI 行为模式
  • 控制代码生成
  • 设置项目特定指南
  • 维护编码标准

基本结构​

1. 规则定义​

rules:
  - name: "React 组件规则"
    pattern: "**/*.tsx"
    guidelines:
      - "使用函数组件"
      - "添加 PropTypes"
      - "包含错误边界"

2. 常见模式​

patterns:
  - name: "API 端点"
    match: "**/api/**/*.ts"
    rules:
      - "使用 async/await"
      - "添加错误处理"
      - "包含请求验证"

最佳实践​

1. 规则组织​

  • 使用清晰的分类
  • 保持规则简洁
  • 添加详细说明
  • 定期更新

2. 规则实现​

  • 定义明确的范围
  • 使用具体示例
  • 包含验证步骤
  • 提供解决方案

3. 规则管理​

  • 版本控制
  • 团队审查
  • 定期评估
  • 更新文档

高级用法​

1. 自定义规则​

custom_rules:
  - name: "API 结构"
    pattern: "**/api/**/*.ts"
    requirements:
      - "使用 REST 标准"
      - "实现错误处理"
      - "添加请求验证"
    examples:
      - "GET /api/users"
      - "POST /api/auth"

2. 规则依赖​

dependencies:
  - name: "TypeScript"
    version: "4.x"
  - name: "React"
    version: "18.x"

故障排除​

1. 规则冲突​

  • 检查规则优先级
  • 验证规则范围
  • 解决重叠问题
  • 更新规则顺序

2. 模式匹配问题​

  • 验证文件路径
  • 检查通配符
  • 测试规则模式
  • 更新匹配规则

3. 规则应用错误​

  • 检查语法
  • 验证配置
  • 更新规则
  • 清理缓存

规则管理最佳实践​

1. 组织​

  • 按项目分类
  • 使用版本控制
  • 维护文档
  • 定期审查

2. 版本控制​

  • 使用语义版本
  • 记录更改
  • 管理依赖
  • 更新说明

3. 团队协作​

  • 共享规则
  • 收集反馈
  • 统一标准
  • 定期同步

使用案例​

1. React 开发​

react_rules:
  - name: "组件结构"
    pattern: "**/*.tsx"
    rules:
      - "使用函数组件"
      - "添加类型定义"
      - "实现错误处理"

2. API 开发​

api_rules:
  - name: "端点规范"
    pattern: "**/api/**/*.ts"
    rules:
      - "使用 REST 标准"
      - "添加请求验证"
      - "实现错误处理"

3. 测试规范​

test_rules:
  - name: "测试结构"
    pattern: "**/*.test.ts"
    rules:
      - "使用 Jest"
      - "添加测试用例"
      - "包含断言"

使用技巧​

1. 开始使用​

  • 从基本规则开始
  • 逐步添加复杂性
  • 测试规则效果
  • 收集反馈

2. 维护规则​

  • 定期更新
  • 检查兼容性
  • 优化性能
  • 更新文档

3. 团队协作​

  • 共享最佳实践
  • 统一标准
  • 收集反馈
  • 持续改进

结论​

MDC 规则是提高代码质量和开发效率的强大工具。通过遵循这些指南和最佳实践，您可以确保规则的有效实施和维护。

记住：

  • 保持规则清晰
  • 定期更新
  • 团队协作
  • 持续改进

通过适当的维护和使用，MDC 规则将成为您开发工作流程中不可或缺的一部分。