不用Rules=白用Cursor!一套规则文件,让团队代码生成合规率飙升80%

前言

Cursor 中输入"帮我生成一个文档管理模块,包括文档名称、文档描述、文档类型、文档URL,以及相关审计字段。"

几分钟后,前后端代码都已经生成,编译也没有问题,但满怀希望的运行后却发现:

  • 项目中默认的 tab 新增页变成了弹窗
  • 蓝色主按钮也变成了绿色 等等。

虽然可以通过指定参考页面来优化,但没法一步到位终究不是那么完美。

今天,我们就来了解下如何通过 Cursor Rules,让 Cursor 生成更规范的代码,大幅减少开发调试时间,真正解放我们的时间!

什么是Cursor Rules

简单理解,Cursor Rules 就是你为 AI 设置的一些规则,你可以定义技术栈、代码规范、目录结构、组件规约等各类要求。

当 AI 生成代码时,这些规则会约束 AI 的各种"奇思妙想",以便生成更加符合预期的项目代码。

全局规则 and 项目规则

打开 Cursor 的 Settings-Rules 界面进行配置。

  • 全局规则 (User Rules)

    这些规则全局起效,适合存放一些个人的编程习惯或实现偏好,例如 Cursor 中文版默认的 "Always respond in 中文" 。

  • 项目规则 (Project Rules)

    这些规则仅对当前项目生效,文件格式存储,方便版本控制,适合整个团队共享相同规则。

    点击 Project Rules 右侧的"Add Rules"即可新增。

    注意,新建的 Rules 文件后缀名是 .mdc,而不是原来的 .cursorrules,但 Cursor 依然兼容原来的 cursorrules,记得勾选 "Includes .cursorrules file" 即可。

规则类型

如上图,我设置了一个项目规则文件tach-stack.mdc,打开它,我们会发现除了文本内容外,最顶部还有一个类型设置。

主要包括以下几种:

  • Always:总是生效,规则内容会始终包含在模型上下文中。
  • Auto Attached :根据后面配置的文件规则才会起效,比如,指定 src 下的文件、指定 java 文件等。
  • Agent Requested:你可以将你的想法写入后面的输入框,AI会判断是否需要追加规则到上下文,比如,当生成界面效果时应用当前规则。
  • Manual:在与 AI 对话时,手动指定规则,比较灵活,仅当通过 @Cursor Rules 显式调用时包含。

适合场景

Cursor Rules 几乎能提升所有开发场景下的 AI 协作效率,尤其在以下几个方面,效果会更明显:

  • 统一技术栈:确保 AI 生成的代码符合项目所使用的框架和库。例如,前端限定使用 Vue 2.6 搭配 Element UI 2.13.2,后端采用 Spring Boot + MyBatis。
  • 遵循编码规范:让 AI 熟悉并遵守团队的代码风格、命名规则和目录结构。比如,"后端的 Controller 类必须放在 com.xxx.<业务模块>.controller 路径下"。
  • 补充关键信息:帮助 AI 更好地理解项目中的核心文件或常用工具的位置。例如,告诉 AI "HTTP 请求的封装工具在 src/utils/request.js 中"。
  • 助力新人快速上手:新同事不熟悉项目结构?有了 Rules,AI 就能直接输出符合项目规范的代码,大大减少学习成本。

Rules 文件怎么来?

高质量的 Rules 是 AI 生成高质量代码的前提。

那么,这些规则从何而来呢?

  1. 自己整理:这是最可靠的方式,但估计也是大家最不喜欢的方式。一句一句地整理技术栈、代码规约、项目约定等内容,耗费巨大,但是长期效果最佳,毕竟,最适合的才是最好的。

  2. 别人分享的 :如果不想写,或者代码本身就是开源框架搭建的,那可以直接采用官网给出的 Rules 范例(cursor.directory/rules),或者其它... Rules 共享网站。

  3. Cursor 自己生成:这是新版本 Cursor 的一大两点,直接在 AI 对话框中输入"/",会弹出快捷指令 "Generate Cursor Rules" 回车后发送指令即可。

个人主技术栈是SpringBoot+Mybatis+Vue2+ElementUI,文末特意整理了一份直接可用的 Rules 文件,需要自取哈~

Cursor Rules 实例:天壤之别

下面,我们通过文章开头的"文档管理模块"场景验证一下 Cursor Rules 的实际效果如何。

作为对比,贴一个项目信息模块界面。

未配置 Rules

提示词

复制代码
帮我生成一个文档管理模块,包括文档名称、文档描述、文档类型、文档URL。

结果

效果

配置 Rules 后

提示词

复制代码
帮我生成一个文档管理模块,包括文档名称、文档描述、文档类型、文档URL。

结果

效果

结语

Cursor 应该是当下最顶级的智能代码编写工具了,加上 Rules 后,就像野马配上了缰绳,它终于可以像我们团队的伙伴一样,高效生成合规代码,真正实现协作编程!

相关推荐
六月的可乐2 分钟前
AI助理前端UI组件-悬浮球组件
前端·人工智能
R-G-B8 分钟前
OpenCV 实战篇——如何测算出任一副图片中的物体的实际尺寸?传感器尺寸与像元尺寸的关系?
人工智能·opencv·工业相机·传感器尺寸·像元·测算图片中的物体尺寸·像元与物体尺寸
Hello123网站15 分钟前
Ferret:苹果发布的多模态大语言模型
人工智能·语言模型·自然语言处理·ai工具
MobotStone17 分钟前
比对手快10倍?更强更精准?谷歌"纳米香蕉"到底藏着什么黑科技
人工智能
爱写代码的小朋友21 分钟前
STEM背景下人工智能素养框架的研究
人工智能
大学生毕业题目1 小时前
毕业项目推荐:83-基于yolov8/yolov5/yolo11的农作物杂草检测识别系统(Python+卷积神经网络)
人工智能·python·yolo·目标检测·cnn·pyqt·杂草识别
居7然1 小时前
美团大模型“龙猫”登场,能否重塑本地生活新战局?
人工智能·大模型·生活·美团
说私域2 小时前
社交新零售时代本地化微商的发展路径研究——基于开源AI智能名片链动2+1模式S2B2C商城小程序源的创新实践
人工智能·开源·零售
IT_陈寒2 小时前
Python性能优化:5个被低估的魔法方法让你的代码提速50%
前端·人工智能·后端
Deng_Xian_Sheng2 小时前
有哪些任务可以使用无监督的方式训练深度学习模型?
人工智能·深度学习·无监督