Reupload
全部AI工具本地AI?
← 返回首页

Skill · Claude Code Documentation

在 Claude.md 文件中嵌入项目规则

在 Claude.md 文件中嵌入项目规则

图片: Matilda Alloway 来自 Unsplash

不必每次会话都重复编码规范。在项目根目录创建 CLAUDE.md 文件,Claude Code 启动时会自动加载你项目的架构、构建命令和编码风格。这种持久记忆在所有开发者会话中都能保留,而且不会占用你的 token 窗口。

Claude Code 的 CLAUDE.md 系统让你可以把项目专属指令直接写进代码仓库。你不必在每次开始新会话时向 Claude 介绍技术栈、命名规范和构建流程,只需创建一个简单的 markdown 文件,Claude 就会自动读取它。

要开始使用,请在 Claude Code 中运行 /init 命令。它会分析你现有的代码库,并生成一份带有相关上下文的初始 CLAUDE.md。之后你可以编辑该文件,加入:构建和测试命令、编码标准、架构决策、文件夹结构和命名规范。将其以 ./CLAUDE.md 存放在根目录,并提交到版本控制中--整个团队都能受益于相同的上下文。

该文件存放在代码仓库中并通过 git 同步,因此每位参与该项目的开发者(以及 Claude Code 本身)都会收到相同的指令。Claude 会从你的工作目录及所有父目录加载 CLAUDE.md 文件,并按顺序将它们拼接起来,因此你可以将项目级规则、团队级规则和个人偏好层层叠加。

例如,如果你正在开发一个 TypeScript/React 项目,你的 CLAUDE.md 可以规定:“始终使用 TypeScript 严格模式,在实现之前用 Vitest 编写单元测试,遵循 ./docs/architecture.md 中的文件夹结构,并使用约定式提交信息。”保存后,Claude Code 会在每次会话中加载它,无需重复说明。

请将文件控制在 300 行以内--Claude 在每次会话开始时都会读取它,而 token 很宝贵。应聚焦于高影响力的标准,而不是冗长的解释。

来源与版权

原始来源: Claude Code Documentation