第82篇:用 AI 统一代码风格——团队规范强制执行

2026/10/09 AI

改了 3 行代码,提交记录显示改了 300 行。

先讲一个真实到让人叹气的场景。

你和同事合作一个项目。你改了一个函数,实际只动了 3 行逻辑。提交上去,同事一看改动记录——300 行标红,300 行标绿。两个人一起花了二十分钟,在 300 行”变化”里找那 3 行真正的改动。

你的编辑器缩进用 4 空格,同事用 2 个;你保存时去掉了行尾空格,他没有;你双引号,他单引号。你一保存,整个文件被”顺手格式化”了一遍。 真正的逻辑改动,被淹没在一片格式噪音里。

这就是代码风格不统一的代价——它不会让程序出错,但让每一次协作都变昂贵。 而且一个人写代码也没这问题:你今天的习惯和三个月前的习惯,往往就是两个人。

这一篇用 AI 一次性解决,而且解决完不用再操心——自动强制执行。


一、先分清:什么是”风格”,什么是”规范”

风格(Style)= 长什么样。 纯外观,改了不影响程序行为,主要体现在这几点:

  • 缩进几个空格
  • 单/双引号
  • 一行多长
  • 括号换不换行
  • 末尾加不加分号

规范(Convention)= 怎么起名、怎么组织。 影响可读性和协作,常见的有:

  • 变量名 userName 还是 user_name
  • 函数前缀 get/fetch/load 用哪个
  • 文件放哪个目录
  • 常量类组件各自写法

这两类处理方式完全不同:

类型 能不能自动改 处理方式
风格(外观) ✅ 能 100% 自动 装个格式化工具,保存自动搞定,根本不需要人管
规范(命名/结构) ⚠️ 只能部分自动 需要先定规矩,AI 帮你检查和批量改

一句话记住:外观交给工具,命名交给 AI + 规矩。

风格vs规范


二、第一步:让 AI 摸清”你的项目现在到底是什么风格”

很多人一上来就搜大厂规范文档,看完更懵。顺序错了。正确第一步是先搞清楚现状——如果项目 80% 代码已是某种写法,你要做的是”向多数靠拢”,而不是引入新标准把 80% 全改一遍。

盘点提示词:

下面是我项目里的几个代表性文件。请盘点当前代码风格现状,输出一张表:
| 项目 | 现在有几种写法 | 各占多少 | 建议统一成哪种 |
盘点项至少含:缩进、引号、变量命名、函数命名、常量命名、文件命名、一行最大长度。
规则:哪种占多数就建议统一成哪种,除非明显有问题(要说明理由)。需要我拍板的单独标出。
不要给我通用的最佳实践,只根据实际代码判断。
【粘贴 3~5 个代表性文件】

最后那句”不要给我通用的最佳实践”很关键——否则 AI 会搬一套业界标准,跟现状对不上,改起来工作量爆炸。

你会得到一张表,比如:缩进 4 空格占 70% → 统一 4 空格;引号单双五五开 → 建议单引号(改动少);变量命名驼峰 90% → 统一驼峰;函数前缀 get/fetch/query 混用 → 需要你定。

带”需要你定”的,通常只有三五条,剩下的 AI 都能替你决定。


三、第二步:把规矩写成一页纸

拍板之后,别把规矩留在脑子里或聊天记录里,写成一个文件放进项目。以后让 AI 写代码,把这一页扔给它,生成的代码天然合规。

生成规范文档提示词:

根据下面的决定,生成一份项目代码规范文档(Markdown):
【贴上你拍板的决定,如:缩进 4 空格 / 单引号 / 变量函数小驼峰 / 常量全大写下划线 / 查询函数统一 get 开头 / 一行不超 100 字符】
要求:1.每条规范给「正确示例」+「错误示例」 2.一句话解释为什么这么定 3.最后加一节「给 AI 用的一句话版本」:把所有规矩浓缩成一段可直接粘的提示词 4.篇幅一页以内。

第 3 点是精华,你会得到一段类似:

本项目代码规范(粘给 AI 用):缩进 4 空格;字符串用单引号;变量和函数用小驼峰;常量全大写下划线分隔;查询类函数统一 get 开头;一行不超 100 字符;每个函数上方写一句话说明用途。

以后让 AI 写任何代码,先把这段粘上,产出直接合规,省掉后面所有返工。

规范两个出口


四、第三步:存量代码怎么改?分两批,千万别一把梭

规矩定好,老代码怎么办?最危险的做法:让 AI 把整个项目一次性改成新规范——改动量巨大,一旦混进逻辑错误根本找不出来。

正确做法分两批:

批次一:纯外观改动,交工具,一次性全改

缩进、引号、空格、换行——100% 不影响程序行为,放心全量执行。别让 AI 一个文件一个文件改(效率低易错),正确做法是让 AI 帮你配个自动格式化工具:

我的项目是【技术栈,如:前端 React / 后端 Java / Python 脚本】。我要加自动代码格式化工具:
1. 推荐这技术栈最主流的格式化工具
2. 给完整配置文件,匹配这些规矩:【贴规矩】
3. 怎么装、怎么设成「保存时自动格式化」
4. 怎么一次性格式化整个项目(一条命令)
5. 全量格式化前要注意什么
我是新手,每步给具体命令和文件位置,不要跳步。

配好之后这类问题永久消失,谁写、写成什么样,保存瞬间自动统一。这是本篇性价比最高的一件事。 ⚠️ 全量格式化前先提交一次代码留备份点,配错了能一键退回。

批次二:命名和结构的改动,只改”你正在动的文件”

命名改动有风险——改一个变量名,五处引用,漏一处就崩。所以采取”渐进式“:不主动改老文件,哪天因业务改动某文件,顺手把那文件命名捋顺。

按下面的规范,把这个文件的命名整理一遍:【贴规范一句话版本】
严格要求:1.只改命名,不改任何逻辑 2.若某名字被文件外部引用(如导出的函数/类),先列出来问我,不要直接改 3.改完给对照表:旧名→新名→改了几处 4.输出完整文件,不要片段
【粘贴文件内容】

第 2 点是安全阀——防止 AI 把对外暴露的名字改了,别的文件全崩。改完跑一遍单元测试(第 79 篇讲过),测试全绿说明改名没改坏。

存量两批改造


五、第四步:让规范自动强制执行(不靠自觉)

规范定了没人遵守,原因简单:靠自觉的规范等于没有规范。 解法:让机器盯,不让人盯。三道防线:

防线 什么时候生效 效果
① 编辑器保存自动格式化 你按 Ctrl+S 那一刻 外观问题永远不会出现
② 提交前自动检查 你敲提交命令那一刻 不合规不让提交,挡在源头
③ 提示词自带规范 你让 AI 写代码时 AI 生成代码天然合规

第 ① 道配格式化工具时顺带做了,第 ③ 道是把规范一句话版本粘给 AI。第 ② 道需单独配置:

我想加一道「提交前自动检查」:代码不符合格式规范就不让提交。技术栈是【填写】,已配了【格式化工具名】。
请给我:1.装什么、安装命令 2.配置文件完整内容和位置 3.怎么验证生效(故意写段不规范代码试试)4.确实需要跳过时怎么跳过
我是新手,给具体命令,不要只说思路。

配完之后,规范从”大家自觉遵守”变成”想不遵守都不行”——这才是”强制执行”。


六、三个坑

坑一:把风格问题拿到会上讨论。 “2 空格还是 4 空格”没有对错只有统一,讨论一小时和抛硬币一样好。让 AI 看现状,哪种占多数用哪种,五分钟结束。

坑二:全量格式化和逻辑改动混在一次提交。 同事永远别想在 3000 行格式变动里找到你那 5 行逻辑。铁律:格式化单独提交一次,说明写清”仅格式化,无逻辑改动”。

坑三:规范定了十七条。 条目越多越没人记得住、越形同虚设。开局最多定 5~8 条最影响阅读的(缩进、引号、命名格式、函数前缀、行宽),跑顺了再加。


七、一次性搞定清单(半小时版)

□ 让 AI 盘点现状,产出「现有几种写法 / 各占多少 / 建议统一成哪种」
□ 只对需人拍板的三五条做决定(通常是命名前缀)
□ 生成一页纸规范文档,含「给 AI 用的一句话版本」
□ 提交一次代码留备份点
□ 让 AI 配格式化工具,开启保存自动格式化
□ 一条命令全量格式化,单独提交,注明"仅格式化"
□ 配置提交前自动检查
□ 把「一句话版本」存备忘录,以后让 AI 写代码先粘上
□ 老文件命名不主动改,改业务时顺手整理当前文件

半小时投入,换来从此再也不用为格式浪费一秒钟。


📦 提示词模板盒子

模板 1 · 盘点项目风格现状

下面是我项目里的几个代表性文件。请盘点当前代码风格现状,输出一张表:
| 项目 | 现在有几种写法 | 各占多少 | 建议统一成哪种 |
盘点项至少含:缩进、引号、变量命名、函数命名、常量命名、文件命名、一行最大长度。
规则:哪种占多数就建议统一成哪种,除非明显有问题(说明理由)。需我拍板的单独标出。
不要给我通用的最佳实践,只根据实际代码判断。
【粘贴 3~5 个代表性文件】

模板 2 · 生成一页纸规范文档

根据下面的决定,生成项目代码规范文档(Markdown):【贴你拍板的决定】
要求:1.每条规范给「正确示例」+「错误示例」 2.一句话解释为什么这么定 3.最后加「给 AI 用的一句话版本」:所有规矩浓缩成一段可直接粘贴的提示词 4.篇幅一页以内。

模板 3 · 配置自动格式化工具

我的项目是【技术栈】。我要加自动代码格式化工具:1.推荐这技术栈最主流的格式化工具 2.给完整配置文件,匹配这些规矩:【贴规矩】 3.怎么装、怎么设成「保存时自动格式化」 4.怎么一次性格式化整个项目(一条命令) 5.全量格式化前要注意什么
我是新手,每步给具体命令和文件位置,不要跳步。

模板 4 · 单文件命名整改(安全版)

按下面的规范,把这个文件的命名整理一遍:【贴规范一句话版本】
严格要求:1.只改命名,不改任何逻辑 2.若某名字被文件外部引用(如导出的函数/类),先列出来问我,不要直接改 3.改完给对照表:旧名→新名→改了几处 4.输出完整文件,不要片段
【粘贴文件内容】

模板 5 · 配置提交前强制检查

我想加一道「提交前自动检查」:代码不符合格式规范就不让提交。技术栈是【填写】,已配了【格式化工具名】。
请给我:1.装什么、安装命令 2.配置文件完整内容和位置 3.怎么验证生效(故意写段不规范代码试试) 4.确实需要跳过时怎么跳过
我是新手,给具体命令,不要只说思路。

模板 6 · 让 AI 写代码时自带规范(日常最常用)

【贴规范一句话版本】
请严格按上面的规范写下面的代码:【你的需求】
写完自查一遍是否每条都遵守,不符合的自行改正后再输出。

🔑 本篇核心口诀

风格分两类:外观交工具,命名交 AI + 规矩。

三步走:盘现状 → 定一页纸 → 自动强制执行。

存量分两批:外观一次全改(零风险),命名渐进式改(改到哪整到哪)。

三道防线:保存自动格式化 + 提交前拦截 + 提示词自带规范。 靠自觉的规范 = 没有规范。


📌 下篇预告

下一篇 《第83篇:用 AI 写 API 文档》,讲怎么让 AI 直接从代码生成一份对接方看得懂的接口文档——包括最易漏、但对方最想知道的部分:错误码、边界情况、和一个能直接复制的调用示例。

Search

    Post Directory