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

Cursor Rules怎么配置代码注释规则?

秋敏小哥_2607

秋敏小哥_2607

发布时间:2026-08-02 14:46:07

|

853人浏览过

|

来源于php中文网

原创

AI生成代码时自动添加合规注释需在项目根目录建.cursor/rules/文件夹,并创建comment-standards.mdc文件,含frontmatter和语言特定注释规范,设置为Always Apply后重启生效。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

cursor rules怎么配置代码注释规则?

让 AI 在生成代码时自动添加符合项目规范的注释,避免出现“// TODO”式敷衍注释或完全不加注释的情况。

创建项目级规则文件

在项目根目录下新建 【.cursor/rules/】 文件夹,这是 Cursor 识别项目规则的唯一有效路径。不要放在 .cursorrules 单文件里,新版规则引擎已不再优先读取该单文件。

进入该文件夹,新建一个名为 【comment-standards.mdc】 的文件——后缀必须是 .mdc,否则 Cursor 不会加载。

写入注释规范内容

打开 comment-standards.mdc,顶部必须写 frontmatter:

---
description: 统一代码注释规范
alwaysApply: true
---

紧接着写明具体要求,例如 Python 项目可这样写:

Cursor 2.4
Cursor 2.4

Agents 正在你的整个代码库中处理越来越复杂、运行时间更长的任务。本次版本引入了新的 agent 框架改进,以实现更好的上下文管理,并在编辑器和 CLI 中带来了许多提升使用体验的修复。

下载

## 注释原则
- 函数必须有 Google 风格 docstring,包含 Args、Returns、Raises
- 类属性用 # 行内注释说明用途,禁止空行隔开
- 禁止出现 `# TODO`、`# FIXME`、`# HACK` 等临时标记
- 复杂逻辑块前加 `#` 注释解释「为什么这么做」,而非「做什么」

Java 项目则要强调 Javadoc 标签:

## Java 注释
- public 方法必须带完整 @param、@return、@throws
- @param 参数名必须与方法签名严格一致,大小写敏感
- @return 描述必须明确返回值语义,如 “非 null 用户对象” 而非 “用户”

设置规则触发方式

回到 Cursor 设置界面 → Rules → 找到刚创建的 comment-standards.mdc → 将 Apply 模式设为 【Always Apply】。

这一步不能跳过:如果选 Auto Attached 或 Specific Files,AI 只在匹配路径时才参考注释规则,而你希望所有新生成函数都自带合规 docstring。

重启 Cursor 编辑器,规则立即生效。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

音述AI
音述AI Hot

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

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

相关专题

更多
marquee参数有哪些
marquee参数有哪些

marquee参数有direction、behavior、speed、scrolldelay、width、height、bgcolor、cursor、id、align、noresize、nohover、loopcount、bgcolorcolor、scrollamount和vspa。

1480

2023.10.18

Cursor新手入门教程
Cursor新手入门教程

这是一份为新手量身定制的 Cursor 入门全流程指南。无论你是刚从 VS Code 迁移过来的老手,还是编程小白,这份指南都能帮你快速上手这款“代码自动驾驶仪”。

113

2026.04.09

Cursor 核心功能深度解析与实战技巧
Cursor 核心功能深度解析与实战技巧

本专题深度剖析 AI 代码编辑器 Cursor 的核心功能,涵盖 Composer 模式、codebase 索引、实时代码预测(Tab)及 Chat 交互等进阶用法。通过丰富的实战案例,手把手教你如何利用 Cursor 快速构建应用、重构复杂代码及进行自动化 Debug。

178

2026.04.16

Cursor 针对不同开发场景的使用教程
Cursor 针对不同开发场景的使用教程

本专题深度拆解 Cursor 在前端 UI 开发、后端重构、数据爬虫及自动化测试等 10+ 核心场景下的具体用法。详解如何针对不同业务场景配置特定的 .cursorrules,让 AI 真正深入你的业务逻辑。

82

2026.04.16

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

20

2026.10.10

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

0

2026.10.10

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

20

2026.10.10

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

20

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Cursor 使用手册
Cursor 使用手册

共0课时 | 0人学习

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

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