在使用Claude Code进行开发时,CLAUDE.md是最容易被忽略却最能提升效率的工具。它是Claude Code在每个会话启动时自动加载的Markdown文件,相当于给AI代理的项目专属说明书,能在AI生成代码前明确项目规则、架构和技术要求。

CLAUDE.md的核心定位
CLAUDE.md不是普通的文档,它是Claude Code的持久化系统提示,每次对话开始前都会被读取。你可以把它理解为给AI的“项目入职培训材料”,不需要每次对话都重复说明项目的基本信息,AI就能快速理解上下文,生成符合项目要求的代码。
编写CLAUDE.md的关键内容
要让CLAUDE.md发挥最大作用,需要覆盖以下几类核心信息:
- 项目基础信息:包括项目的技术栈、核心功能、目录结构说明,让AI快速了解项目整体情况。
- 编码规范:比如命名规则、缩进风格、注释要求、禁用语法等,避免AI生成不符合团队规范的代码。
- 架构约束:比如模块划分规则、依赖引入限制、接口设计规范,防止AI写出破坏项目架构的代码。
- 常见问题说明:比如已知的技术坑点、特定场景的处理方式,减少AI重复犯错的几率。
CLAUDE.md的结构组织技巧
杂乱的内容会让AI难以抓取重点,建议按照清晰的层级组织内容:
1. 分层存放
可以在项目根目录放全局的CLAUDE.md,在子模块目录下放对应模块的CLAUDE.md,Claude Code会自动读取所有层级的文件,既保证全局规则统一,又能针对子模块做特殊说明。
2. 用标题区分模块
使用h2、h3等标题划分不同内容模块,比如“编码规范”“架构要求”“测试规则”,让AI能快速定位对应内容。
3. 避免冗余信息
不要放和开发无关的内容,比如项目的业务背景介绍、非技术类的团队规则,只保留和技术实现、代码生成相关的内容。
CLAUDE.md示例模板
以下是一个适配通用前端项目的CLAUDE.md示例,你可以根据自己的项目情况调整:
# 项目CLAUDE.md ## 项目基础信息 - 技术栈:Vue3 + TypeScript + Vite - 核心功能:企业后台管理系统,包含用户管理、订单管理、数据统计模块 - 目录结构: - src/views:页面组件目录 - src/components:公共组件目录 - src/api:接口请求目录 - src/utils:工具函数目录 ## 编码规范 - 变量命名采用小驼峰,组件命名采用大驼峰 - 缩进使用2个空格,禁止使用tab - 每个函数必须添加注释说明功能、参数、返回值 - 禁止使用var声明变量,统一使用let和const ## 架构约束 - 页面组件必须在src/views下按模块划分目录,禁止跨模块引用组件 - 接口请求必须封装到src/api对应模块下,禁止在组件中直接写请求逻辑 - 状态管理使用Pinia,禁止在组件中直接修改store外的状态 ## 常见问题说明 - 表格组件统一使用Element Plus的el-table,禁止自行封装表格组件 - 表单校验统一使用async-validator,校验规则放在对应的表单组件内
常见编写误区
很多开发者编写CLAUDE.md时会踩以下坑:
- 内容过于简略:只写几行技术栈信息,AI无法获取足够的上下文,生成代码容易不符合要求。
- 内容过于冗长:把项目的所有文档都塞进去,AI读取时会分散注意力,反而抓不住重点。
- 规则矛盾:比如一会儿要求用2空格缩进,一会儿要求用4空格缩进,会让AI无所适从。
只要按照上述方法编写CLAUDE.md,就能让Claude Code更精准地理解你的项目需求,减少无效沟通,大幅提升开发效率。
CLAUDE.mdClaude_CodeAI代理代码库规范系统提示修改时间:2026-05-31 04:06:33