AI生成代码时自动添加合规注释需在项目根目录建.cursor/rules/文件夹,并创建comment-standards.mdc文件,含frontmatter和语言特定注释规范,设置为Always Apply后重启生效。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

让 AI 在生成代码时自动添加符合项目规范的注释,避免出现“// TODO”式敷衍注释或完全不加注释的情况。
创建项目级规则文件
在项目根目录下新建 【.cursor/rules/】 文件夹,这是 Cursor 识别项目规则的唯一有效路径。不要放在 .cursorrules 单文件里,新版规则引擎已不再优先读取该单文件。
进入该文件夹,新建一个名为 【comment-standards.mdc】 的文件——后缀必须是 .mdc,否则 Cursor 不会加载。
写入注释规范内容
打开 comment-standards.mdc,顶部必须写 frontmatter:
---
description: 统一代码注释规范
alwaysApply: true
---
紧接着写明具体要求,例如 Python 项目可这样写:
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 编辑器,规则立即生效。

















