CLAUDE.md 配置文件
通过 CLAUDE.md 配置文件个性化定制 Claude Code,打造专属 AI 助手。
CLAUDE.md 是你的个人 AI 助手记忆文件,让 Claude 完全按照你的偏好和项目需求工作!
管理方式
使用 /memory 命令
# 编辑 CLAUDE.md 记忆文件
/memory
使用 /init 命令
# 初始化项目并创建 CLAUDE.md 指南
/init
配置位置和优先级
用户级配置(全局)
# 用户目录下的全局配置
~/.claude/CLAUDE.md
适用于所有项目的通用设置和偏好。
项目级配置(优先级更高)
# 项目根目录
./CLAUDE.md
项目特定的配置会覆盖全局设置。
工作原理
⚠️
重要:CLAUDE.md 内容以用户消息的形式添加到对话中,不会修改系统提示。这与输出样式不同,输出样式会完全替换系统提示。
CLAUDE.md 在每次新对话时自动加载,内容作为用户消息发送给 Claude,让它了解你的偏好和项目上下文。
基础配置示例
# 我的 Claude Code 配置
## 编程风格偏好
- 使用 TypeScript 而不是 JavaScript
- 优先选择函数式编程风格
- 使用 const/let 而不是 var
- 所有函数都要有类型注解
## 代码约定
- 使用 2 空格缩进
- 函数名使用 camelCase
- 常量使用 UPPER_SNAKE_CASE
- 导入语句按字母顺序排列
## 项目信息
- 项目类型:Next.js + TypeScript
- 样式框架:Tailwind CSS
- 数据库:PostgreSQL with Prisma ORM
- 状态管理:Zustand
- 测试框架:Jest + Testing Library
## 开发工作流
- 每次修改后运行 `npm run lint`
- 提交前必须运行 `npm test`
- 使用 Conventional Commits 格式
- 所有 PR 都需要代码审查
高级配置
团队协作配置
## 团队开发规范
### Git 工作流
- 使用 feature/task-name 分支命名
- 所有 commit 必须遵循 Conventional Commits
- PR 标题格式:[类型] 简短描述
- 代码必须通过所有 CI 检查
### 代码质量
- 所有函数必须有 JSDoc 注释
- 测试覆盖率不低于 80%
- 禁止使用 any 类型
- 所有异步操作必须有错误处理
### 审查要求
- 每个 PR 至少需要 2 个审查者
- 安全相关变更需要 security team 审查
- 数据库变更需要 DBA 确认
团队协作:将项目级 CLAUDE.md 放入 Git 仓库,确保团队成员使用统一配置和标准!
自定义命令别名
## 快捷命令定义
当我说"快速部署"时,执行以下步骤:
1. 运行测试套件
2. 构建生产版本
3. 部署到 staging 环境
4. 运行冒烟测试
5. 如果通过则部署到生产环境
当我说"全面检查"时,执行:
1. ESLint 代码检查
2. TypeScript 类型检查
3. 单元测试 + 集成测试
4. 性能测试
5. 安全扫描
项目特定知识
## 项目架构说明
### 目录结构
- `src/components/` - 可复用组件
- `src/pages/` - Next.js 页面
- `src/lib/` - 通用工具函数
- `src/hooks/` - 自定义 React hooks
- `src/types/` - TypeScript 类型定义
### 重要约定
- 所有 API 调用通过 `src/lib/api.ts`
- 环境变量前缀必须是 `NEXT_PUBLIC_` 或 `APP_`
- 组件 props 接口以 `Props` 后缀命名
- 自定义 hooks 以 `use` 前缀命名
### 已知问题和解决方案
- Safari 中的 CSS Grid 问题:使用 flexbox 替代
- 移动端滚动问题:添加 -webkit-overflow-scrolling: touch
- 图片优化:使用 Next.js Image 组件,尺寸比例 16:9
最佳实践
配置分层策略
- 全局配置 (
~/.claude/CLAUDE.md
) - 个人编程偏好和通用规范 - 项目配置 (
./CLAUDE.md
) - 项目特定的架构、约定和业务逻辑
维护建议
## 配置维护
- 定期更新技术栈版本信息
- 根据项目演进调整规范
- 删除过时的配置项
- 与团队同步配置变更
与其他功能的关系
- 与输出样式区别:CLAUDE.md 是附加信息,输出样式是行为模式
- 与 /config 区别:/config 管理 Claude Code 设置,CLAUDE.md 管理项目和代码偏好
- 与 MCP 服务器配合:可在 CLAUDE.md 中说明如何使用项目的 MCP 服务器
实际效果示例
不使用 CLAUDE.md
Claude:我来帮你创建一个登录组件。
// 创建了基本的 JavaScript 组件
使用 CLAUDE.md 后
Claude:根据你的配置偏好,我来创建一个 TypeScript 登录组件,
使用 Tailwind CSS 样式,遵循你的 camelCase 函数命名约定,
并添加完整的类型定义。
// 创建了符合项目规范的 TypeScript 组件
CLAUDE.md 让每次交互都更符合你的项目需求和个人偏好!