Cursor Rules 使用

news2025/7/28 23:22:06

前言

最近在使用 Cursor 进行编程辅助时,发现 AI 生成的代码风格和当前的代码风格大相径庭。而且有时它会输出很奇怪的代码,总是不符合预期。

遂引出本篇,介绍一下 Rules ,它就可以做一些规范约束之类的事情。

什么是 Cursor Rules?

简单来说,Cursor Rules 是一系列可配置的指令或约束条件,用于指导 CursorAI 助手在生成、修改或理解你的代码时的行为。

你可以把 Rules 想象成给你的 AI 助手制定的“公司规范”或“项目指南”。它告诉助手:

  • 应该做什么: 比如“在修改 API 文件时,必须添加 Swagger 注释”。
  • 不应该做什么: 比如“禁止使用 var 关键字”、“不要引入 common 库,除非绝对必要”。
  • 如何做: 比如“使用 4 个空格缩进”、“字符串统一使用双引号”、“结构体字段必须使用驼峰”。

通过设置 Rules,可以确保 AI 生成或修改的代码符合你个人、团队或项目的特定风格、约定、最佳实践和安全要求,减少后续手动调整的工作量,并保持代码库的一致性。

Cursor Rules 分为2种

  • User Rules 全局生效,例如:总是以中文回答。
  • Project Rules 只对当前项目生效,通常配置一些框架规则,API 规范等。
    在这里插入图片描述

Project Rules

如果是针对现有项目,可以直接让 Cursor 为你生成 Rules

/Generate Cursor Rules

在这里插入图片描述

实际的开发场景中,Rules 主要分为三个层级:

  1. 通用规则 (global.rules): 适用于所有项目和工作区,不论编程语言和使用的框架,例如变量驼峰命名等。
  2. 编程语言规则 (language.rules): 针对特定编程语言生效。例如,Go 使用标准库 net/http 进行 API 开发。
  3. 框架规则 (framework.rules): 针对特定框架或技术栈生效。

通用规则

  • 示例规则:
    • 代码风格:
      // 强制在所有语言中使用 2 个空格缩进 (除非被语言/框架规则覆盖)
      use_spaces: true
      indent_size: 2
      
      // 要求 AI 在修改或生成代码时添加清晰的注释说明改动原因 (非强制,但强烈建议)
      require_explanatory_comments: true
      
    • 安全与最佳实践:
      // 禁止生成或建议已知不安全的函数/模式 (通用层面,具体需在语言规则细化)
      avoid_unsafe_functions: true
      
      // 要求 AI 优先考虑内存安全和性能 (通用指导原则)
      prioritize_memory_safety_and_performance: true
      
    • AI 交互:
      // 要求 AI 在每次使用 /edit 前都先询问确认 (避免意外覆盖)
      confirm_before_edit: true
      
      // 限制 /edit 一次能修改的最大行数 (防止过大范围改动)
      max_edit_lines: 100
      

编程语言规则

  • 典型用途: 定义特定语言的语法约定、风格指南、语言特有的最佳实践、推荐/禁用的库或特性。
  • 示例规则 (Python - python.rules):
    // 遵循 PEP 8 风格指南 (作为基础)
    style_guide: pep8
    
    // 强制类型提示 (Type Hints):要求 AI 在生成函数/方法时添加参数和返回值的类型注解
    require_type_hints: true
    
    // 指定字符串引号规则
    string_quotes: single # 统一使用单引号 (')
    
    // 要求使用 `pathlib` 代替 `os.path` 进行路径操作 (更现代)
    prefer_pathlib: true
    
    // 禁止使用 `print` 语句,要求使用 `logging` 模块进行输出 (适用于非脚本场景)
    no_print_statements: true
    

框架规则

  • 示例规则 (Next.js - nextjs.rules):
    // 要求使用 Next.js 内置的 `Link` 组件进行客户端导航
    use_next_link: true
    
    // 指定数据获取方法:优先使用 `getServerSideProps` 或 `getStaticProps`, 避免在组件顶层使用 `useEffect` 获取初始数据
    data_fetching: server_side_or_static_props
    
    // 遵循 Next.js 特定的文件路由约定 (pages/api, pages/[slug].js 等)
    follow_app_router_conventions: true # 如果使用 App Router (v13+)
    follow_pages_router_conventions: true # 如果使用 Pages Router
    
    // 要求 API 路由处理函数遵循特定结构 (req, res) 或 (request: NextRequest)
    api_route_structure: standard
    

总结

个人理解,Cursor Rules 就类似于 LLMPrompt。是一个强大的工具,它将 AI 的强大能力与你或团队的特定需求和规范无缝结合。

  • 大幅提升代码一致性: 确保 AI 生成的代码从一开始就符合你的风格指南和最佳实践。
  • 减少返工: 避免花费时间修正 AI 生成代码的格式、风格或不符合框架约定的问题。
  • 强制执行最佳实践和安全: 防止 AI 引入不安全或低效的代码模式。
  • 定制 AI 行为:AI 助手真正成为符合你项目上下文的智能协作者。

花些时间根据你的工作流和项目需求精心配置 Rules很有用,这时间值得花,会发现 CursorAI 助手变得更加精准、高效,真正成为提升你开发生产力的得力伙伴。

参考

  • Cursor 首席设计师 Ryo Lu 的文章,关于如何正确使用Cursor
  • Cursor官方下场谈Cursor正确用法
  • Cursor Rules在实际开发中的三种层级&实际应用(附20个常用Rules)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2404807.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

服务器数据恢复—服务器raid5阵列崩溃如何恢复数据?

服务器数据恢复环境&故障: 某品牌型号为X3850服务器上有一组由14块数据盘和1块热备盘组建的raid5磁盘阵列。 服务器在正常使用过程中突然崩溃,管理员查看raid5阵列故障情况的时发现磁盘阵列中有2块硬盘掉线,但是热备盘没有启用。 服务器数…

Go语言堆内存管理

Go堆内存管理 1. Go内存模型层级结构 Golang内存管理模型与TCMalloc的设计极其相似。基本轮廓和概念也几乎相同,只是一些规则和流程存在差异。 2. Go内存管理的基本概念 Go内存管理的许多概念在TCMalloc中已经有了,含义是相同的,只是名字有…

【DAY41】简单CNN

内容来自浙大疏锦行python打卡训练营 浙大疏锦行 知识点: 数据增强卷积神经网络定义的写法batch归一化:调整一个批次的分布,常用与图像数据特征图:只有卷积操作输出的才叫特征图调度器:直接修改基础学习率 卷积操作常…

使用MinIO搭建自己的分布式文件存储

目录 引言: 一.什么是 MinIO ? 二.MinIO 的安装与部署: 三.Spring Cloud 集成 MinIO: 1.前提准备: (1)安装依赖: (2)配置MinIO连接: &…

K7 系列各种PCIE IP核的对比

上面三个IP 有什么区别,什么时候用呢? 7 series Integrated Block for PCIE AXI Memory Mapped to PCI Express DMA subsystem for PCI Express 特点 这是 Kintex-7 内置的 硬核 PCIe 模块。部分事务层也集成在里面,使用标准的PCIE 基本没…

natapp 内网穿透失败

连不上网络错误调试排查详解 - NATAPP-内网穿透 基于ngrok的国内高速内网映射工具 如何将DNS服务器修改为114.114.114.114_百度知道 连不上/错误信息等问题解决汇总 - NATAPP-内网穿透 基于ngrok的国内高速内网映射工具 nslookup auth.natapp.cnping auth.natapp.cn

深入解析CI/CD开发流程

引言:主播最近实习的时候发现部门里面使用的是CI/CD这样的集成开发部署,但是自己不是太了解什么意思,所以就自己查了一下ci/cd相关的资料,整理分享了一下 一、CI/CD CI/CD是持续集成和持续交付部署的缩写,旨在简化并…

Docke启动Ktransformers部署Qwen3MOE模型实战与性能测试

docker运行Ktransformers部署Qwen3MOE模型实战及 性能测试 最开始拉取ktransformers:v0.3.1-AVX512版本,发现无论如何都启动不了大模型,后来发现是cpu不支持avx512指令集。 由于本地cpu不支持amx指令集,因此下载avx2版本镜像: …

应用分享 | 精准生成和时序控制!AWG在确定性三量子比特纠缠光子源中的应用

在量子技术飞速发展的今天,实现高效稳定的量子态操控是推动量子计算、量子通信等领域迈向实用化的关键。任意波形发生器(AWG)作为精准信号控制的核心设备,在量子实验中发挥着不可或缺的作用。丹麦哥本哈根大学的研究团队基于单个量…

相机--相机标定实操

教程 camera_calibration移动画面示例 usb_cam使用介绍和下载 标定流程 单目相机标定 我使用的是USB相机,所以直接使用ros的usb_cam功能包驱动相机闭关获取实时图像,然后用ros的camera_calibration标定相机。 1,下载usb_cam和camera_calibration: …

DAY43 复习日

浙大疏锦行-CSDN博客 kaggle找到一个图像数据集,用cnn网络进行训练并且用grad-cam做可视化 进阶:把项目拆分成多个文件 src/config.py: 用于存放项目配置,例如文件路径、学习率、批次大小等。 # src/config.py# Paths DATA_DIR "data…

【Auto.js例程】华为备忘录导出到其他手机

目录 问题描述方法步骤1.安装下载Visual Studio Code2.安装扩展3.找到Auto.js插件,并安装插件4.启动服务器5.连接手机6.撰写脚本并运行7.本文实现功能的代码8.启动手机上的换机软件 问题描述 问题背景:华为手机换成一加手机,华为备忘录无法批…

单片机的低功耗模式

什么是低功耗? STM32的低功耗(low power mode)特性是其嵌入式处理器系列的一个重要优势,特别适用于需要长时间运行且功耗敏感的应用场景,如便携式设备、物联网设备、智能家居系统等。 在很多应用场合中都对电子设备的…

架构师级考验!飞算 JavaAI 炫技赛:AI 辅助编程解决老项目难题

当十年前 Hibernate 框架的 N1 查询隐患在深夜持续困扰排查,当 SpringMVC 控制器中错综复杂的业务逻辑在跨语言迁移时令人抓狂,企业数字化进程中的百万行老系统,已然成为暗藏危机的 “技术债冰山”。而此刻,飞算科技全新发布的 Ja…

手机端抓包大麦网抢票协议:实现自动抢票与支付

🚀 手机端抓包大麦网抢票协议:实现自动抢票与支付 🚀 🔥 你是否还在为抢不到热门演出票而烦恼?本文将教你如何通过抓包技术获取大麦网抢票协议,并编写脚本实现自动化抢票与支付!🔥 …

[TIP] Ubuntu 22.04 配置多个版本的 GCC 环境

问题背景 在 Ubuntu 22.04 中安装 VMware 虚拟机时,提示缺少 VMMON 和 VMNET 模块 编译这两个模块需要 GCC 的版本大于 12.3.0,而 Ubuntu 22.04 自带的 GCC 版本为 11.4.0 因此需要安装对应的 GCC 版本,但为了不影响其他程序,需…

如何思考?分析篇

现代人每天刷 100 条信息,却难静下心读 10 页书。 前言: 我一直把思考当作一件生活中和工作中最为重要的事情。但是我发现当我想写一篇跟思考有关的文章时,却难以下手。因为思考是一件非常复杂的事情,用文字描述十分的困难。 读书…

Redis:Hash数据类型

🌈 个人主页:Zfox_ 🔥 系列专栏:Redis 🔥 Hash哈希 🐳 ⼏乎所有的主流编程语⾔都提供了哈希(hash)类型,它们的叫法可能是哈希、字典、关联数组、映射。在Redis中&#…

快捷键的记录

下面对应的ATL数字 ATL4 显示编译输出 CTRL B 编译 CTRLR 运行exe 菜单栏 ALTF ALTE ALTB ALTD ALTH

Python读取阿里法拍网的html+解决登录cookie

效果图 import time from selenium import webdriver from selenium.webdriver.chrome.options import Options from selenium.webdriver.chrome.service import Service from webdriver_manager.chrome import ChromeDriverManager from lxml import etreedef get_taobao_auct…