加载中...
返回AI 编程实战
AI 编程知识库 · AI 编程实战 · OpenCode 系统性指南

AGENTS.md进阶:教AI你的编码规范

概念图

引言

当你第一次运行 /init 命令,Claude Code 会自动扫描项目并生成一份 AGENTS.md 文件。这份自动生成的配置确实能帮助 AI 理解项目基础结构,但很快你会发现它远远不够——AI 生成的代码风格不统一、命名随意、缺少测试、Git 提交信息混乱……问题接踵而至。本文将深入讲解如何通过 AGENTS.md 进阶配置,真正教会 AI 你的编码规范,让它成为懂你风格的得力助手。


一、官方生成的AGENTS.md为什么不够用

自动生成的局限性

Claude Code 的 /init 命令会分析 package.json、README.md、现有代码结构等信息,生成一份基础配置。这份配置通常包含:

  • 项目描述和目录结构
  • 基本的安装和运行命令
  • 技术栈识别(React、Vue、Python 等)

然而,自动生成无法捕捉以下关键信息:

编码风格偏好:你喜欢单引号还是双引号?用不用分号?缩进是 2 空格还是 4 空格?这些细节 AI 无法从代码结构推断。

团队约定:分支命名规则、提交信息格式、PR 审核流程——这些是团队内部约定的,不会体现在代码中。

业务领域知识:你的项目涉及特定领域的业务逻辑,比如电商的订单状态流转、金融的交易风控规则,这些知识需要显式告诉 AI。

安全与合规要求:哪些 API 密钥不能提交、敏感数据如何处理、日志记录规范——这些往往没有代码痕迹。

一个真实的例子

假设你运行 /init 后得到这样的 AGENTS.md:

# My Project

React + TypeScript 项目

## 开发命令
- npm install
- npm run dev
- npm test

这看起来还行,但当你让 AI 创建一个新组件时,可能会得到:

  • 组件没有 TypeScript 接口定义
  • 使用了你团队不推荐的 Class 组件
  • 样式写成了内联形式
  • 忘记添加必要的错误处理

这就是自动生成的局限性——它只知道"是什么",不知道"应该怎样"。


二、项目级 vs 全局规则

OpenCode 提供了多层次的规则配置体系,理解这个体系是进阶配置的基础。

规则优先级(从高到低)

层级 文件位置 作用范围 说明
AI 编程知识库会员专享内容
开通后解锁「AGENTS.md进阶:教AI你的编码规范」全文,AI 编程知识库全年访问

扫码添加企业微信,找大熊掌门开通会员

企业微信二维码

添加后说明想开通的会员类型即可

加载中...