首页 / 教程 / 编码工具

AGENTS.md 与项目规则:让 AI 每次都按你的规范写代码

用 AI 写代码最常见的重复劳动,不是打字,是讲规范:新开一个对话,就得再贴一遍"我们用 TypeScript、缩进两格、组件放 src/components、别引新的依赖库"。贴多了会漏,漏一次,AI 给你的就是一套风格完全不同的代码,改起来比自己写还累。

规则文件:给 AI 的一份入职手册

现在主流的编码工具都支持项目规则文件:在仓库根目录放一份 AGENTS.md(Cursor、Claude Code 等各自有对应的配置文件,思路完全一样),工具每次启动对话时会自动读取它的内容,当作长期记忆注入给模型。你不用再手动粘贴,规范跟着仓库走。

把它理解成新同事的入职手册就行:技术栈是什么、目录怎么组织、命名怎么起、哪些事绝对不能做。手册写得清楚,新人不问也知道;写得含糊,问一百遍还是会错。

规则文件不是越长越好——AI 记不住的东西,等于没写。

AGENTS.md 里该写什么

建议只写三块内容。第一块是硬约束:语言和框架版本、缩进与换行风格、明确禁止的事项(比如"不要引入新的状态管理库")。第二块是常用路径与命令:入口文件在哪、测试怎么跑、构建命令是什么——AI 有了这些就能自己验证改动。第三块是一小段示例代码,一正一反各一个,比十行描述都管用。

写法上有三个要点:用祈使句,一条一行,按小节编号。别写背景故事,也别写"我们团队一直以来的习惯是"这类模糊表述——模型无法执行模糊。

一条规则如果你自己都记不清,AI 也不会遵守。

让规则真正生效的三个做法

第一,把规则接进评审闭环。AI 交出代码后,对照规则文件逐条检查再合并;发现违反的,把对应条目贴回对话让它改。检查三五次后,遵守率会明显上升——模型会顺着反馈调整。

第二,分层放置。仓库根目录放全局约定,前端、后端等子目录再各放一份局部规则,工具会就近取用。全局文件保持精简,只放对所有代码都成立的事。

第三,定期修剪。每次 AI 犯同样的错,就把对应的规则写进文件;反过来,连续几周没再触发的条目就删掉。规则文件控制在两屏以内,超了就说明该合并同类项了。

常见问题

规则文件和系统提示词有什么区别

系统提示词在工具端配置,改一次只影响一个工具;规则文件跟着仓库走,换工具、换机器、换同事都用同一份,还能提交进版本管理,改动有记录可查。

规则写了 AI 还是不遵守怎么办

多半是规则太多互相打架。把最关键的三五条置顶,其余删掉或合并;调用时也可以明确引用,比如"按 AGENTS.md 第 2 节的约定重构",把模型的注意力引到具体条目上。

老项目没有规范能补吗

可以反向生成:让 AI 读现有代码,把实际风格总结成规则草稿,人工过一遍再固化进文件。不用一次写全,先从最痛的一条开始,比如缩进或命名。

让团队规范随仓库走

在项目根目录建一份 AGENTS.md,把规范写清,再接入你顺手的编码工具。规范落地了,AI 才是帮手而不是返工机器。

留言交流

有问题、有补充,写两句吧~留言会实时显示在下方(无需注册)。

留言加载中…
← 上一篇:把自建 API 接进 Cursor / VSCode:AI 写代码实战 下一篇:命令行 AI 编码工具:aider / opencode 接入自建 API →