为什么需要这个#
想象一下您雇了一个助手。第一天您向他解释规则:“我们用这种格式写报告”、“回复客户要礼貌”、“文件存放在这个文件夹里”。没有这些规则,助手会按自己的方式做一切。
CLAUDE.md 是一个为 Claude Code 记录这些规则的文件。您在里面写下指令,Claude 在每次对话中都会遵循。这能节省时间:不需要每次都重复同样的话。
什么是 CLAUDE.md#
CLAUDE.md 是一个使用 Markdown 特殊格式的普通文本文件(扩展名 .md)。Markdown 是一种使用简单符号格式化文本的方式:# 用于标题,- 用于列表,** 用于粗体文字。
Claude Code 在每次对话开始时读取这个文件并遵循其中的规则。
CLAUDE.md 文件的类型#
Claude Code 支持多个层级的指令。可以把它想象成不同范围的规则:
| 类型 | 位置 | 适用对象 |
|---|---|---|
| 项目级 | 项目文件夹中的 CLAUDE.md |
整个团队 |
| 个人级 | ~/.claude/CLAUDE.md |
仅限您,适用于所有项目 |
| 本地级 | 项目文件夹中的 CLAUDE.local.md |
仅限您,仅在此项目中 |
💡
~符号表示您计算机上的主目录。例如,在 Mac 上是/Users/您的用户名/。
分步指南:创建 CLAUDE.md#
步骤1:打开项目文件夹#
在终端中进入项目文件夹:
cd my-project步骤2:创建 CLAUDE.md 文件#
打开文本编辑器,在项目根目录创建 CLAUDE.md 文件。以下是内容示例:
# 项目规则
## 代码风格
- 用中文写注释
- 使用易于理解的变量名
- 每个函数不超过20行
## 项目结构
- 源代码在 src/ 文件夹中
- 测试在 tests/ 文件夹中
- 配置在 config/ 文件夹中
## 重要命令
- 运行项目:npm start
- 运行测试:npm test
- 构建:npm run build步骤3:验证 Claude 读取了文件#
在项目文件夹中启动 Claude Code:
claude问:“你知道哪些项目规则?"——Claude 应该列出您在 CLAUDE.md 中写的内容。
有用的指令示例#
用于网站#
# 项目:咖啡馆网站
## 技术
- HTML、CSS、JavaScript
- 框架:不使用,纯代码
## 规则
- 所有文本使用中文
- 品牌颜色:#FF6B35(橙色)、#004E89(蓝色)
- 移动设备响应式布局用于个人设置(~/.claude/CLAUDE.md)#
# 我的偏好
- 用简单的语言解释代码
- 始终为代码添加注释
- 提供多种解决方案
- 用中文回答用于本地设置(CLAUDE.local.md)#
# 我的本地设置
- 我的测试服务器:http://localhost:3000
- 调试使用端口 9229Claude 的自动记忆#
除了 CLAUDE.md 文件外,Claude Code 还能自主记忆信息。在工作过程中它会保存有用的观察:
- 项目模式(代码如何组织)
- 复杂问题的解决方案
- 您的工作偏好
这些笔记存储在 ~/.claude/projects/<项目>/memory/ 文件夹中并自动加载。
建议#
- ✅ 写具体的内容:“使用2个空格缩进"比"写得漂亮点"好
- ✅ 当规则变化时更新文件
- ✅ 将
CLAUDE.md添加到版本控制系统(Git)中,让团队使用统一的规则 - ✅ 不要将
CLAUDE.local.md添加到 Git 中——那是您的个人设置
课程总结#
- CLAUDE.md 是 Claude 在每次对话开始时读取的指令文件
- 有三个层级:项目级(团队共用)、个人级(您的全局设置)、本地级(您在某个项目中的设置)
- 更具体的设置优先于一般设置
- Claude 还会自动保存笔记(自动记忆)
- 好的指令能节省时间并使 Claude 的工作更可预测