自学教程

CLAUDE.md 使用指南

Claude Code 教程

简介

CLAUDE.md 是 Claude Code 的项目说明文件，放在项目根目录，会话启动时自动加载，用来告知 Claude Code 项目架构、技术栈、编码规范、任务约束与工作流程。
它相当于项目专属的系统提示词，所有对话都会默认读取这份文档。

优先级：项目根目录 CLAUDE.md > .claude/CLAUDE.md > 用户全局 ~/.claude/CLAUDE.md
兼容：项目存在 AGENTS.md，Claude Code 也可识别使用。

什么时候需要 CLAUDE.md

  • 多人协作项目，统一 Claude 的编码输出风格
  • 项目技术栈复杂，每次对话不想重复介绍项目信息
  • 需要强制约定工作流程（例如修改代码前必须输出 Coding Plan）
  • 需要限制 Claude 的行为，禁止修改某些目录、文件

创建 CLAUDE.md

  1. 在项目根目录新建文件，文件名 CLAUDE.md（大小写敏感）
  2. 写入项目信息、规则、约束
  3. 保存文件；新建会话才会生效，已经打开的对话不会自动读取

也可以使用 claude init 命令交互式自动生成基础 CLAUDE.md

CLAUDE.md 标准模板

# 项目概述
项目名称：XXX
技术栈：Nuxt4 + TypeScript + TailwindCSS V4 + Shadcn/ui
项目简介：前端管理系统# 架构说明
- 页面放在 pages/
- 组件放在 components/
- API请求封装在 src/api
- 状态管理使用 useState
# 编码规范
1. 使用TypeScript，严格类型定义
2. Vue组件使用组合式API
3. 样式优先使用Tailwind，不新增全局CSS
4. 函数必须写注释，入参和返回值标明类型
# 工作流程（强制）
1. 收到需求，先输出Coding Plan
2. Coding Plan审核通过后，再修改代码
3. 修改完成，提供简单测试验证方案
# 禁止操作
1. 禁止修改数据库迁移文件
2. 禁止修改.env、环境配置文件
3. 不删除已有业务代码，如需移除优先注释

写作要点

  1. 项目信息：技术栈、目录结构、框架版本，减少重复提问
  2. 编码规范：命名、代码格式、语法要求，保证输出风格统一
  3. 工作流程：强制步骤，如先规划再编码
  4. 约束限制：禁止修改的文件、目录，禁止使用的依赖/写法
  5. 输出格式：规定代码块、注释、文档输出格式

✅ 建议简短精炼，不要写过长内容，避免占用过多上下文Token。
❌ 不要放入密钥、密码、私钥等敏感信息。

加载与生效规则

  1. 新建会话时一次性加载；会话运行期间修改 CLAUDE.md，不会自动刷新
  2. 更新文件后，执行 /clear 清空当前对话，开启新会话才能生效
  3. 根目录 CLAUDE.md 优先级最高，会覆盖 .claude/CLAUDE.md 和全局配置

版本控制建议

  1. ✅ 将 CLAUDE.md 提交到 Git，团队成员共用一套项目规则
  2. ✅ 项目升级技术栈、调整架构时，同步更新 CLAUDE.md
  3. ✅ 搭配 .claude/ignore 屏蔽敏感文件，形成完整项目配置体系

IDE 和 CLI 使用

  • VS Code：直接在根目录编辑 CLAUDE.md，保存后新开对话生效
  • JetBrains IDE：同上面，编辑完成后，在 Claude Code 面板新建会话
  • CLI：/clear 清空会话，重新输入需求即可加载新规则

常见问题

  1. 写了 CLAUDE.md，但 Claude 没有遵守规则
  • 检查文件位置，必须放在项目根目录；文件名大小写正确
  • 确认已经 /clear 新建会话，旧会话不会重载文件
  • 规则描述尽量清晰具体，不要模糊描述
  1. CLAUDE.md 内容太长，消耗大量Token？
    精简文档，只保留核心规则；把细粒度权限放到 .claude/rules。
  2. 全局 CLAUDE.md 和项目 CLAUDE.md 会合并吗？
    会合并加载；项目根目录 CLAUDE.md 的规则优先级更高，会覆盖冲突配置。

安全提示

  • CLAUDE.md 会被 Claude Code 读取，严禁写入密钥、账号密码、证书。
  • 如果有文件不允许 Claude 访问，在 .claude/ignore 配置。
标签：

0 条笔记