教程

写好 CLAUDE.md:让 Claude Code 记住项目规矩

Claude Code 入门第 2 课:用 /init 生成 CLAUDE.md,写清楚命令、约定和注意事项;分清项目、个人和全局几个位置,用 /memory 管理自动记忆。附可直接改的模板。

灵点AI 约 6 分钟读完 最后验证 2026.10.18
本篇目录

本文按 Claude Code 官方文档整理,2026 年 10 月核对。如有出入,以官方文档为准。

写好 CLAUDE.md

为什么需要 CLAUDE.md

Claude Code 每开一次新对话,都是从零开始的:它不记得上次你说过「用两个空格缩进」「提交前先跑测试」。

CLAUDE.md 就是解决这个问题的。它是一个普通的 Markdown 文件,放在项目里。Claude Code 每次启动都会先读它,相当于每次开工前先看一遍「项目须知」。

什么时候该往里写?官方给的判断很实用:

  • 同一个错误,Claude 犯了第二次
  • 同一句提醒,你这次又打了一遍
  • 新同事来了,也需要先知道的事

第一步:用 /init 生成初稿

在项目文件夹里启动 Claude Code,输入:

/init

它会分析整个项目,生成一份 CLAUDE.md 初稿:怎么安装依赖、怎么构建和测试、代码放在哪、有什么约定。如果项目里已经有 CLAUDE.md,/init 会给出修改建议,不会直接覆盖。

初稿只是起点。它能从代码里看出来的东西有限,真正有价值的是你补充的那些「只有你知道」的规矩。

第二步:写上真正有用的内容

一份好用的 CLAUDE.md 通常包括这几块。下面是一个可以照着改的模板:

# 项目说明
这是公司官网,Astro + TypeScript,部署在阿里云服务器。
## 常用命令
- 本地预览:npm run dev
- 构建:npm run build
- 提交前必须运行:npm run check
## 代码约定
- 缩进用 2 个空格
- 页面组件放在 src/pages/,公共组件放在 src/components/
- 所有对外文案用简体中文,不要出现英文占位符
## 注意事项
- 不要修改 deploy/ 文件夹里的脚本
- 改动样式后,同时检查亮色和暗色两种模式

写的时候记住三点:

  • 具体到能检查:写「缩进用 2 个空格」,不要写「代码格式要规范」;写「提交前运行 npm run check」,不要写「记得测试」
  • 短:官方建议每个 CLAUDE.md 控制在 200 行以内。越长越占空间,Claude 也越容易漏看
  • 不矛盾:两条规矩打架,Claude 可能随便挑一条执行。定期回头删掉过时的内容

CLAUDE.md 可以放在哪

不同位置,管的范围不一样:

CLAUDE.md 的四个位置和各自的作用范围

  • 项目根目录的 CLAUDE.md:整个团队共用的项目规矩,跟着代码一起提交到 Git
  • 项目根目录的 CLAUDE.local.md:只属于你自己的项目偏好,比如你的测试账号、本地地址。记得把它加进 .gitignore,不要提交
  • 你电脑上的 ~/.claude/CLAUDE.md:你的个人习惯,对所有项目都生效,比如「回答用中文」「解释时多举例子」
  • 公司统一下发的 CLAUDE.md:由管理员放在系统目录里,对公司所有人生效

这几份不会互相覆盖,而是一起读进来。越靠近你启动的文件夹,越后读到。

文件太长?拆开引用

可以在 CLAUDE.md 里用 @路径 引用别的文件:

项目介绍见 @README.md
接口约定见 @docs/api-rules.md

被引用的文件也会在启动时一起读进来。注意:拆开只是让文件更好管理,并不会少占空间。只在某些文件夹里才需要的规矩,可以放到 .claude/rules/ 里,只在处理对应文件时才加载。

它自己也会记笔记

除了你写的 CLAUDE.md,Claude Code 还有一个「自动记忆」:你纠正过它的地方、你的偏好,它会自己记到笔记里,下次自动带上。界面上出现「Saved 2 memories」这类提示,就是它在记。

输入 /memory 可以:

  • 查看和编辑所有 CLAUDE.md 文件
  • 打开或关闭自动记忆
  • 打开自动记忆所在的文件夹,看看它都记了什么

想确认这次启动到底读了哪些 CLAUDE.md,运行 /context 看一下。

一个要分清的地方

CLAUDE.md 是「提醒」,不是「锁」。Claude 会尽量遵守,但不保证百分之百。

真正不能碰的东西,比如「绝不能读 .env 文件」「绝不能 git push」,要用权限规则或钩子来强制,方法在第 3 课和第 5 课。

这一课学到的

  • CLAUDE.md 是 Claude Code 每次开工前都会读的「项目须知」
  • 先用 /init 生成初稿,再补上只有你知道的规矩
  • 写具体、写短、不矛盾,控制在 200 行以内
  • 团队规矩放 CLAUDE.md,个人偏好放 CLAUDE.local.md 或 ~/.claude/CLAUDE.md
  • 用 /memory 管理记忆,用 /context 检查读进了什么

本系列

「Claude Code 上手」一共 8 课:前 5 课是基础,第 6 到 8 课是进阶篇,建议按顺序看:

还没装好?先看 10 分钟装好 Claude Code。