一条规则文件,让 Comate 写出的代码直接就是你们团队的格式

yeye WPS Comate 19

为什么 AI 写的代码总要返工格式
AI 给的是”通用正确”的代码,不是你们团队的代码:缩进、命名、注释、import 顺序,每样都要人肉改一遍,提省下的时间又被格式吃回去了。

解法不是把提示词写得更长,而是把长期规则从单次对话里拆出来——”前端统一 2 空格缩进”这种要求,写一次,永远生效,不用每次交代。

规则写在哪:三层落地
项目规则文件(核心):在项目根目录放一份规则文件(业界标准为 AGENTS.md)。规则随仓库走,改规则能走 commit、diff、回滚;新人 clone 下来,AI 立刻认这套规矩。建议分层:根目录管全局风格和测试要求(100~250 行),子目录补模块约定(30~120 行),别全塞一个文件。
助理人设/规则(个人级):官方说明中,助理「创建同款」后人设、规则、技能、知识库都可以改。把”代码必须符合团队规范,不确定先问我”写进人设,每次自动生效。
技能共享(团队级):按官方技能创建四步法(一句话目的 → 输出结构 → 技能文件 → 用户视角检验)把”按规范生成组件”写成技能,上传共享后,你优化一次规范,全员拉取即生效。
风格规则怎么写才有效
只写团队私有约定:「请求必须走 @/api/request 封装」有价值;「可以用 fetch」是废话,AI 本来就会。
代码示例 > 文字:直接贴一段团队标准写法(命名、返回值、loading 处理全在里面),比一百字描述都准。
可执行可验证:❌「写高质量代码」→ ✅「新增接口必须带参数校验和成功/失败两个测试」。判不出”违反了”的规则就删掉。
三档边界:✅ 放手做(新建组件)|⚠️ 先问我(动公共代码、加依赖)|🚫 绝不要(动配置文件、硬编码密钥)。

可直接抄的模板

# 项目开发规则
## 代码风格
– 缩进 4 空格;函数 camelCase,组件 PascalCase,文件 kebab-case
– 公共函数必须写 JSDoc;import 顺序:标准库 → 第三方 → 项目内
## 硬性规则(违反即打回)
1. 禁止直接 fetch,一律走 @/api/request
2. 禁止 any / as any
3. 不做无关重构,不全量格式化
## 完成定义
– lint、类型检查、测试全通过才算交付;测试失败不得删除或跳过

三步验证生效
先考它:新任务第一句问”本项目代码风格规则有哪几条”,答不全说明没读到规则文件。
再派活:下发真实小任务,看产出是否直接符合风格、无需手改格式——这是唯一验收标准。
前几次跑偏很正常,把偏差补进规则文件,而不是补进对话。
通关清单
☑ 单次提示词管”本次做什么”,规则文件管”永远怎么写”
☑ 团队风格已写进项目根目录规则文件,每条规则都能判”违反了”
☑ 验证过:AI 产出不用再手工改格式
写在最后:以前是你迁就 AI 的默认格式,现在规则写一次,AI 每次进项目先学会你们的规矩——省下的不只是改格式的几分钟,而是整套规范再也不用口口相传。

回复

我来回复
  • 暂无回复内容

立即咨询 企业版试用 上门服务

请您留言

感谢您的关注,你可留下联系方式,我们将第一时间与您联系。