8. CLAUDE.md — 项目记忆系统


CLAUDE.md 是 Claude Code 最重要的功能之一,相当于给 AI 一份"项目备忘录"。每次启动 Claude Code 时,它会自动读取项目目录下的 CLAUDE.md 文件,从而了解项目的技术栈、编码规范和特殊要求。

创建 CLAUDE.md

在项目目录下运行:

claude
> /init

Claude Code 会自动分析项目结构,生成一份初始的 CLAUDE.md。你也可以手动创建和编辑。

CLAUDE.md 推荐结构

# 项目名称

## 项目概述
简要描述项目的功能和目的。

## 技术栈
- 前端:React 18 + TypeScript + Tailwind CSS
- 后端:Node.js + Express + PostgreSQL
- 测试:Jest + React Testing Library
- 部署:Docker + AWS ECS

## 常用命令
- 启动开发服务器:`npm run dev`
- 运行测试:`npm test`
- 构建生产版本:`npm run build`
- 数据库迁移:`npm run migrate`
- 代码检查:`npm run lint`

## 编码规范
- 使用函数式组件和 React Hooks,不使用 class 组件
- 文件命名使用 kebab-case
- 组件命名使用 PascalCase
- 所有函数必须有 TypeScript 类型注解
- 提交信息遵循 Conventional Commits 规范

## 项目结构
- `src/components/` — 可复用 UI 组件
- `src/pages/` — 页面级组件
- `src/api/` — API 请求层
- `src/hooks/` — 自定义 Hooks
- `src/utils/` — 工具函数

## 注意事项
- 数据库连接字符串在 .env 文件中配置
- 不要直接修改 generated/ 目录下的文件
- 所有 API 路由都需要经过认证中间件

CLAUDE.md 文件层级

Claude Code 支持多级 CLAUDE.md 文件:

位置作用示例
~/.claude/CLAUDE.md全局配置,所有项目生效个人编码风格偏好
项目根目录 CLAUDE.md项目级配置技术栈、架构、团队规范
子目录 CLAUDE.md模块级配置特定模块的特殊规则

💡 提示:CLAUDE.md 写得越详细,Claude Code 的输出质量就越高。花 10 分钟配置 CLAUDE.md,可以节省数小时的反复修正。

评论

0
还没有评论,来写第一条吧