编程助手:CLAUDE.md 与 AGENTS.md 完全指南

目录

1. 为什么需要这两个文件

1.1 两个文件的定位

1.2 传统 README.md vs AI 配置文件

2. CLAUDE.md 深度解析

2.1 什么是 CLAUDE.md

2.2 文件位置与优先级

2.3 CLAUDE.md 应该包含什么

2.3.1 常用命令

2.3.2 代码风格指南

React组件规范

命名规范

2.3.4 开发规范和注意事项

2.4 CLAUDE.md 完整示例

📦 常用命令

🎨 代码规范

TypeScript

React/JSX

导入顺序

🏗️ 架构说明

数据流模式

关键目录职责

路由设计

🧪 测试规范

测试文件位置

测试要求

⚠️ 重要约束

不允许的操作

必须遵守的规范

🔧 调试与问题排查

常见问题

日志级别

📚 文档与资源

2.6 CLAUDE.md 优化技巧

3. AGENTS.md 深度解析

3.1 什么是 AGENTS.md

3.2 AGENTS.md vs CLAUDE.md

3.3 AGENTS.md 的优先级机制

3.4 AGENTS.md 应该包含什么

3.4.1 项目概述

3.4.2 构建和测试命令

3.4.3 代码风格和规范

3.4.4 测试说明

覆盖率要求

变更类型

测试说明

影响范围

3.5 AGENTS.md 完整示例

目录结构规范

🤖 AI 行为配置

代码生成风格

禁止模式

🧪 测试策略

单元测试

E2E测试

测试重点

🔐 安全规范

权限控制代码模板

📦 子应用注册规范

注册配置模板

🔄 版本兼容性

3.7 从 AGENT.md 迁移到 AGENTS.md

4. 实践案例:从零配置新项目

4.1 项目背景

4.2 创建项目结构

4.3 配置 CLAUDE.md(根目录)

🛠️ 常用命令

根级别

Web前端

API后端

📐 代码规范

通用规范

React/TypeScript规范

Python/FastAPI规范

🧪 测试策略

Web端

API端

⚠️ 重要约束

依赖管理

环境变量

Git钩子

🤖 AI行为指南

📁 目录导航

当前正在开发的功能

关键文件位置

🏗️ 架构决策记录

ADR-001: 状态管理方案

ADR-002: API版本策略

🔄 开发工作流

1. 功能开发流程

2. PR模板

🧠 AI行为偏好

代码补全风格

回答风格

📊 性能基准

Web端

API端

任务看板模块 (src/features/board)

🧪 测试规范

组件测试模板

测试数据工厂

📱 响应式设计断点

🚫 禁止模式

🔧 调试技巧

React DevTools配置

性能分析

🗄️ 数据库操作规范

Repository模式

查询优化

🧪 测试规范

测试数据库

API测试模板

🔐 安全规范

密码处理

JWT配置

📝 错误处理规范

统一异常处理

📊 性能优化

数据库连接池

缓存策略

🎨 样式规范

Tailwind类名顺序

主题变量

📚 Storybook规范

故事模板

🔧 构建与发布

构建命令

版本发布流程

🚫 组件设计红线

验证配置效果

5. 最佳实践与进阶技巧

5.1 内容组织原则

5.2 优先级和强调

5.3 团队协作策略

5.4 常见问题解决

5.5 与 CI/CD 集成

5.6 配置文件模板

常用命令

📐 代码规范

TypeScript/JavaScript

CSS/样式

🧪 测试要求

⚠️ 注意事项

.env 必需配置

🗄️ 数据库

🧪 测试

🔐 安全规范

6. 总结

6.1 核心要点回顾

6.2 选择建议

6.3 未来展望

参考资料

官方文档

社区资源

工具推荐

延伸阅读


1. 为什么需要这两个文件

1.1 两个文件的定位

核心痛点:AI编程助手(Claude Code、Cursor、GitHub Copilot等)在接手陌生项目时,往往面临以下问题:

  • 不知道如何运行项目(npm start还是python app.py?)

  • 不了解代码规范(使用分号吗?缩进2格还是4格?)

  • 不清楚项目架构(MVC?DDD?还是Clean Architecture?)

  • 不知道测试命令(jest、pytest还是go t

CLAUDE.md:AI编程助手项目规范指南与模板实践 在软件工程中,项目规范与配置管理是保障代码一致性、可维护性的基础。通过定义明确的技术栈、目录结构和编码约定,团队能够高效协作,减少认知负担。其核心原理在于将隐性知识显性化,形成可执行的约束规则。这一实践的技术价值在于显著降低沟通成本,提升代码质量,并加速新成员融入。在AI辅助编程日益普及的背景下,传统的项目文档难以被AI准确理解,导致生成代码与项目实际规范脱节。CLAUDE.md作为一种专为AI设计的项目配置文件,通过具体、可测试的指令,将项目特定约束注入AI的上下文,使其从“通用程序员”转变为“项目专属搭 阅读详情

相关推荐

AI编程助手记忆层配置指南:CLAUDE.md与AGENTS.md实战解析

1. 先搞清楚“记忆层”到底在解决什么问题 如果你用过 Claude Code、Codex 或 OpenCode 这类 AI 编程助手,肯定遇到过这种情况:你让它修改一个文件,它改得挺好;但当你让它接着改另一个相关文件时,它好像完全忘了刚才做了什么,或者对项目的整体结构又得重新理解一遍。这种“健忘”就是“记忆层”要解决的核心痛点。 所谓的“记忆层”,并不是指 AI 模型本身的长上下文能力,而是指这些编程助手工具为了在 单个项目 或 单次会话 中保持工作连贯性,所采用的一套工程化方案。它通常通过项目根目录下的

weixin_34210740的博客 379

AI编程助手记忆层深度解析:CLAUDE.md与AGENTS.md配置实战

在 AI 编程助手(Agent)的日常使用中,你是否遇到过这样的困扰:昨天刚让 Claude Code 重构了一个模块,今天它却对项目的整体架构一问三不知;或者,你向 Codex 详细解释了业务规则,但在处理后续任务时,它仿佛得了“健忘症”,一切又得从头说起。这背后,是 AI 编程助手“记忆”能力的核心差异。对于需要长期维护、迭代的复杂项目,一个能“记住”项目上下文、团队约定和过往决策的智能助手,其效率提升是指数级的。 本文将深入剖析当前三大主流 AI 编程助手——Claude Code、OpenAI Co

weixin_33851177的博客 354

CLAUDE.md与AGENTS.md:给AI编程助手建项目记忆的完整指南

在AI编程助手日益普及的今天,开发者往往面临同一个困境:模型无法自动理解庞大仓库的隐性规则。这背后是上下文窗口有限,AI只能依赖当前文件与手动粘贴的信息,导致依赖猜测、命令错误、代码风格偏离等问题。为弥补这一缺口,项目级指令文件应运而生,其中CLAUDE.md与AGENTS.md成为主流实践。通过将技术栈、常用命令、目录约定、禁区等显式写入Markdown文件,AI在进入仓库时能够快速建立“项目记忆”,显著减少无效对话与低级错误。这类配置不仅适用于Claude等特定工具,也被多家AI编码代理广泛支持,适合在

weixin_35238815的博客 279

AI编程助手长期记忆配置指南:用CLAUDE.md与AGENTS.md告别失忆

大语言模型本身不具备跨会话记忆能力,每次对话都被限制在独立的上下文窗口中,这导致AI编程助手每次进入项目都像“新实习生”。通过为Claude Code、Codex、VS Code插件及Qoder等工具配置CLAUDE.md、AGENTS.md等记忆文件,可以将项目简介、技术栈、常用命令与代码规范固化到上下文中,实现长期记忆。这类配置基于纯文本文件,可提交到Git仓库供团队共享,且修改后即时生效。从上下文工程的角度看,记忆文件本质上是一种轻量级的Prompt前置注入,能够显著减少重复沟通成本,提升AI在真实项

weixin_29056781的博客 331

AGENTS.md 完全指南:让 AI 编程助手真正听懂你的项目

在 AI 编程工具日益普及的今天,如何让 Claude Code、Codex 等助手准确理解项目上下文成为关键挑战。AGENTS.md 作为一份面向 AI 的上下文契约,通过定义项目结构、命令清单、代码约定和禁区规则,解决了 AI 会话失忆和团队协作标准化问题。它不仅是提示词版本管理的载体,更是提升 AI 编程效率、降低返工率的核心实践。本文深入解析 AGENTS.md 的编写方法、常见陷阱与进阶玩法,帮助开发者和团队构建可复用的 AI 协作规范。

weixin_30952479的博客 176

AI编程助手项目记忆层实战:CLAUDE.md与AGENTS.md配置指南

你让 AI 编程助手帮你重构一个模块,它改得挺好。第二天,你让它继续优化另一个相关文件,它却像失忆了一样,问你要上下文,甚至把昨天定好的命名规范都忘了。这不是模型不够聪明,而是工具没“长记性”。 这就是当前 AI 编程助手(Agent)最核心的痛点: 短期记忆 。一次对话能记住,换个会话就清零。对于需要跨文件、跨会话协作的复杂开发任务,这简直是灾难。好消息是,主流工具——Claude Code、OpenAI Codex 和 OpenCode——都意识到了这个问题,并各自给出了解决方案: 项目记忆层 。 它们

shirlly 165

2026最新Claude Code 规范文件 CLAUDE.md 全面解析与超全模板

磨刀不误砍柴工,无论是新项目还是老项目,一定要花点时间 做好这个规范,有了它,不仅能提升我们的与AI 交互效率,还能大幅度降低token(与AI 反复拉扯,token 嘎嘎涨)

十年老程序猿,AI 疯狂研究专家,前沿硬核知识分享 1511

CLAUDE.md 与 AGENTS.md 实战指南:一套模板同时喂饱 Claude Code 与 Codex

CLAUDE.md / AGENTS.md 的本质,是把团队口耳相传的工程默契,变成版本化、可评审、对所有 AI 助手生效的显式资产。精确的比模糊的强,小的比大的强,持续维护的比一劳永逸的强。从第四章的骨架开始,挑一个第五章到第七章的模板填进去,在下一个真实任务里跑一遍,然后把 Agent 犯的每个错变成文件里的一条新规则——几周之后,你会得到一份比任何新人文档都值钱的东西。

篮球界最会写bug的人;程序猿中打球最菜的人。 510

EPLAN二次开发入门:Visual Studio 2019环境配置与插件调试实战

本文详细介绍了EPLAN二次开发入门的关键步骤,重点讲解如何在Visual Studio 2019中配置开发环境并进行插件调试。通过创建符合命名规范的项目、引用核心API库、实现插件接口以及使用附加进程调试等实战技巧,帮助电气工程师快速掌握EPLAN插件开发,提升自动化设计效率。

h6i7j8的博客 763

基于TMS320F28034的SCI技术简介

28034的SCI没有接入DMA总线,不过它的收发都有4级的FIFO,在一定程度上也能够缓解cpu的压力。 本文的设计思想如下: 接收:通过中断的方式,4级FIFO满后在中断里将RXDATA出栈。不过就存在这种情况,发送端发出的数据未必能填满4级FIFO,然而此时配置的是4级FIFO触发中断,所以这种情况下中断无法及时地触发。怎么办? 本文的做法是在主程序下循环读取FIFO。这样就可以确保在数据高速传输时,通过中断和主程序及时和有效地接收到总线的数据。(不过当总线波特率较低时可能中断是几...

weixin_48388779的博客 1410

ANSYS ACT插件开发实战指南:从IronPython脚本到XML界面设计

本文提供了一份详尽的ANSYS ACT插件开发实战指南,重点讲解如何利用IronPython脚本实现仿真自动化,并通过XML设计用户友好的向导界面。内容涵盖从环境搭建、脚本编写(如自动创建材料)、界面控件绑定到调试打包的全流程,旨在帮助仿真工程师和团队负责人将重复性工作流程标准化,显著提升ANSYS软件的使用效率。

weixin_29310605的博客 458

基于YOLOv10深度学习的花生种子霉变检测系统

YOLO(You Only Look Once)是当前最先进的目标检测算法之一,具有快速、精准的特性。YOLOv10是YOLO系列的最新版本,相较于之前的版本,YOLOv10在特征提取、模型精度和速度上都有了显著的提升。YOLOv10采用了更深的卷积神经网络、更多的跨层特征融合方法,使得其在不同尺寸物体的检测和复杂场景的处理上都表现出了优异的性能。YOLOv10特别适合应用在需要快速处理并检测大量图像的任务中,如花生种子霉变检测等,能够实现精准、高效的检测。

2201_76125393的博客 649

基于深度学习的疲劳驾驶检测系统:YOLOv11+UI界面实现

WIDER FACE:包含32,203张图像和393,703个人脸标注YawDD:专门用于驾驶员疲劳检测的数据集,包含不同光照条件下的驾驶员视频自收集数据集:在不同光照条件和驾驶场景下收集的驾驶员面部数据。

YOLO 264

X书x-mini-sig_x-mini-mua

X书的tiny风控代码,成功运行x-mini-sig|x-mini-mua

Codeooo 博客 1万+

IPD流程中的RR\OR\IR\PB\SR\AR\CR等名词汇总(基于新的产品包需求架构)

RR:Raw Requirement,原始需求=》IR:Initial Requirement,初始需求=》SR:System Requirement,系统需求=》AR:Allocated Requirement,分配需求=》CR:Process Change Requirement,流程变更需求。

a1809032425的博客 3198

大模型技术全景与核心概念解析:从基础原理到AI智能体架构(实时更新中)

本文系统解析了大模型技术的核心概念与架构。首先介绍了LLM(大语言模型)、LLMOps(模型运维)、AIGC(生成内容)、AGI(通用AI)等基础概念,重点阐述了大模型的工作原理,包括预处理、推理和后处理三个阶段。深入讲解了Token分词、FLOPs计算、Embedding向量表示等关键技术,并分析了LoRA微调、MoE架构等前沿方法。文章还探讨了AI智能体的发展前景,为理解大模型技术提供了全景视角。

算法工程师 1283

数学建模模型总结

这是本人在两年内准备参加数学建模竞赛搜集到的模型资料,已经经过了本人的筛选和整理,希望能够对准备参加数学建模竞赛的学弟学妹们提供一些帮助!

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

STM32F407中文手册

STM32f407中文手册 本参考手册面向应用开发人员,提供有关使用 STM32F405xx/07xx、STM32F415xx/17xx、 STM32F42xxx 和 STM32F43xxx 微控制器存储器与外设的完整信息。STM32F405xx/07xx、STM32F415xx/17xx、STM32F42xxx 和 STM32F43xxx 构成一个微 控制器系列,各产品具有不同的存储器大小、封装和外设。有关订购信息以及器件的机械与电气特性,请参见数据手册。有关 ARM Cortex™-M4F 内核的信息,请参见《Cortex™-M4F 技术参考手册》。

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

上一篇: Claude & Codex Skills 完整实战指南
下一篇: Milvus + LangChain + Ollama 搭建生产级 RAG
BlueSea 每日coding
BlueSea 每日coding 新星创作者: Go技术领域 新星创作者: Go技术领域
博客等级 码龄14年 3454粉丝 929原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

BlueSea 每日coding

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值
⌂ 换网址