Claude Code官方指南:CLAUDE.md项目说明书写法,让AI跨会话记忆测试命令与项目结构

终端和VS Code都会用了,但Claude还是每次重复追问“测试怎么跑”“目录在哪儿”——本讲把CLAUDE.md加上自动记忆机制写清楚,让它跨会话也能记住项目约定。
官方文档参考
CLAUDE.md:https://code.claude.com/docs/en/claude-md
Memory:https://code.claude.com/docs/en/memory
细节以官方页面为准;以下是结合文档和实际使用的个人笔记。
CLAUDE.md 是什么?
CLAUDE.md是一个放在项目根目录的说明文件,作用是让Claude Code在每次会话开始时自动读取,从而了解项目的基本约定。你可以把它理解为“写给AI的项目说明书”。
它的核心价值在于:不用每次新建会话都重新解释一遍项目结构、测试命令、代码规范等背景信息。AI自动读取后,回答会更贴合你的项目上下文。
CLAUDE.md 应该写什么?
建议包含以下内容:
• 项目名称和一句话简介
• 技术栈(语言、框架、主要依赖)
• 目录结构说明(关键文件夹的用途)
• 常用命令(如何运行、如何测试、如何构建)
• 代码风格或规范要点(缩进、命名约定等)
• 常见坑或注意事项
不需要写太长,半页到一页就够。AI不需要知道每个文件的细节,只需要知道项目的大致轮廓和关键约定。
怎么写:用/init生成初稿
如果你不确定从哪里开始,可以直接用/init命令。它会扫描项目结构,生成一份CLAUDE.md的初稿。然后你再根据实际情况修改和补充,比自己从头开始写要快得多。
另一个方式是让AI直接帮你起草:“帮我写一份CLAUDE.md,这个项目是React + TypeScript,测试用Jest,启动命令是npm start。”
.claudeignore:哪些文件不需要AI看
和.gitignore类似,.claudeignore用来告诉Claude Code哪些文件或目录不需要读取。比如node_modules、dist、build、.env等。这能减少上下文噪声,让AI的注意力集中在真正重要的代码上。
建议在项目初始化时一并配置好,避免AI在不相关的文件上浪费token。
Auto Memory:AI自己记住的东西
除了你主动写的CLAUDE.md,Claude Code还会通过Auto Memory功能自动记录会话中的一些信息。比如你提过“这个项目不用Redux”,或者“测试环境需要mock这个接口”——这些信息会被保存下来,跨会话生效。
你可以在会话中用/memory命令查看当前AI记住了什么,或者手动添加/删除记忆条目。如果发现记忆有误,随时可以修正。
三者的关系
• CLAUDE.md:你主动写的项目说明书,版本可控,适合放入代码仓库。
• /init:自动生成CLAUDE.md初稿的工具,省去从零开始的麻烦。
• Auto Memory:AI自己记录的零散信息,不需要你手动维护。
• .claudeignore:控制AI的读取范围,减少噪声。
跟做清单
• 在项目根目录创建一份CLAUDE.md文件
• 用/init生成初稿并补充内容
• 配置.claudeignore,排除不需要AI读取的目录
• 跑过一次会话,确认AI能自动读取项目说明
• 查看/memory,了解AI记住了哪些信息
