人人都会AI编程

3.4.4 @规则:导入团队编码规范

更新时间:2026-06-30

团队长期维护的项目通常有统一的命名约定、接口返回格式或安全红线。@规则允许你将这些规范写成文本文件,在对话中通过 @规则 引用,让 AI 在生成、重构或审查代码时自动遵循团队约定,而不是使用通用风格。

创建与配置规则文件

规则文件本质是纯文本(如 team-rules.mdcoding-standard.txt),建议纳入项目仓库或团队共享网盘,方便版本同步。内容以条目化、指令化写法最佳,例如:

1. 所有 API 接口返回必须包裹在 { code: number, data: any, message: string } 结构中
2. React 组件必须使用函数式声明,props 需先解构再使用
3. 数据库查询必须参数化,严禁字符串拼接 SQL
4. 工具函数命名采用 camelCase,常量采用 UPPER_SNAKE_CASE
5. 循环体内禁止直接发起异步请求

在对话中引用

在侧边栏对话面板输入框中,键入 @规则,系统会提示选择本地规则文件或历史已引用的规则。也可直接指定路径,如 @规则 ./docs/frontend-rules.md。引用成功后,当前会话的生成与审查都会默认按该规则执行,多轮对话中无需重复引用。

典型应用场景

  • 统一新代码风格:要求 AI "写一个用户分页查询接口",引用规则后,生成的代码会自动使用团队规定的返回结构、异常处理方式和命名规范,避免事后手工调整。
  • 批量合规审查:选中一段旧代码或整个目录,提问"检查是否符合团队规范",AI 会逐条比对规则文件,指出命名不一致、缺少参数校验等问题。
  • 跨团队交接:新成员不熟悉项目约定时,直接引用规则文件进行对话,相当于让 AI 充当一位随时在场的技术导师。

使用建议

  • 规则文件条目建议控制在 30–50 条以内,按"命名规范"、"接口协议"、"安全要求"等分块组织,避免条目过多导致重点被稀释。
  • 表述尽量具体可执行。例如将"注意性能"改写为"列表查询必须带分页参数,单页上限 100 条",AI 的遵循率会显著提升。
  • 企业版用户通常由管理员在后台统一维护组织级规则,团队成员在 @规则 中直接选择"团队默认"即可自动关联,无需每人手动上传。