MYAIGC

主题

CLAUDE.md配置指南 ​

CLAUDE.md是Claude Code的项目记忆文件。它在每次会话开始时自动加载，让Claude了解你的项目规范、架构决策和团队约定。

什么是CLAUDE.md？ ​

CLAUDE.md是一个放在项目根目录的Markdown文件：

your-project/
├── CLAUDE.md        ← 项目记忆文件
├── src/
├── tests/
└── package.json

作用 ​

  • 项目上下文 - 让Claude理解项目架构
  • 编码规范 - 定义代码风格和最佳实践
  • 常用命令 - 记录构建、测试、部署命令
  • 团队约定 - 共享开发约定和决策

基础模板 ​

markdown
# 项目概述

这是一个使用Next.js 14构建的电商网站。

## 技术栈

- **前端**: Next.js 14 + TypeScript + Tailwind CSS
- **后端**: Next.js API Routes
- **数据库**: PostgreSQL + Prisma
- **认证**: NextAuth.js
- **部署**: Vercel

## 常用命令

```bash
npm run dev        # 启动开发服务器
npm run build      # 构建生产版本
npm run test       # 运行测试
npm run lint       # 运行ESLint
npm run type-check # TypeScript类型检查

代码规范 ​

  • 使用TypeScript严格模式
  • 使用函数组件和Hooks
  • 组件文件使用PascalCase命名
  • 工具函数使用camelCase命名
  • 所有公开函数需要JSDoc注释

测试要求 ​

  • 使用Jest和React Testing Library
  • 测试覆盖率不低于80%
  • 每个组件都需要测试文件

## 完整配置示例

```markdown
# AI编程教程网站

## 项目概述

这是一个使用VitePress构建的AI编程教程网站，目标是提供从入门到精通的AI编程学习资源。

## 技术架构

### 前端
- **框架**: VitePress 1.5+
- **语言**: TypeScript
- **样式**: CSS + 自定义主题

### 内容结构

docs/ ├── getting-started/ # 入门篇 ├── prompt-engineering/ # 提示词工程 ├── tools/ # AI编程工具 ├── coding/ # AI辅助编程 ├── llm-dev/ # 大模型应用开发 └── projects/ # 项目实战


## 常用命令

```bash
# 开发
npm run docs:dev

# 构建
npm run docs:build

# 预览
npm run docs:preview

写作规范 ​

文章结构 ​

  1. 开篇引入（为什么重要）
  2. 核心概念解释
  3. 实际代码示例
  4. 最佳实践总结
  5. 小结表格

代码示例 ​

  • 必须可运行
  • 包含必要注释
  • 展示输入输出

语言风格 ​

  • 语言活泼、循循善诱
  • 由浅入深、循序渐进
  • 使用表格总结要点

SEO要求 ​

  • 每篇文章有明确的H1标题
  • 合理使用H2、H3层级
  • 关键词自然融入内容
  • 代码块标注语言类型

文件命名 ​

  • 使用小写字母和连字符
  • 示例：basic-usage.md, mcp-integration.md

不要做的事 ​

  • 不要使用emoji（除非用户要求）
  • 不要杜撰不确定的知识点
  • 不要创建不必要的文件
  • 不要添加过度的格式化

## 多层级配置

支持在不同目录放置CLAUDE.md，实现分层配置：

project/ ├── CLAUDE.md # 全局配置 ├── frontend/ │ └── CLAUDE.md # 前端特定配置 └── backend/ └── CLAUDE.md # 后端特定配置


### 全局配置

```markdown
# 项目全局配置

## 通用规范

- 所有代码使用TypeScript
- 所有文件使用UTF-8编码
- 所有提交使用Conventional Commits格式

## 禁止事项

- 不要提交敏感信息
- 不要禁用ESLint规则
- 不要跳过测试

前端配置 ​

markdown
# 前端配置

## 技术栈

- React 18
- TypeScript 5
- Tailwind CSS

## 组件规范

- 使用函数组件
- 使用CSS Modules
- Props必须定义类型

## 状态管理

- 全局状态：Zustand
- 服务端状态：React Query

后端配置 ​

markdown
# 后端配置

## 技术栈

- Node.js 20
- Express
- PostgreSQL + Prisma

## API规范

- RESTful设计
- 统一的错误响应格式
- 所有接口需要认证

## 数据库

- 使用Prisma迁移
- 软删除使用deletedAt字段

自动记忆 ​

Claude Code会自动学习并记录到CLAUDE.md：

markdown
## 自动记忆

### 已学习的项目信息

- 构建命令：`npm run build`
- 测试框架：Jest
- 主要入口：src/index.ts
- 常见错误解决方案：
  - TypeError in auth.ts: 检查环境变量JWT_SECRET

初始化CLAUDE.md ​

bash
# 让Claude自动生成CLAUDE.md
claude "/init"

或者手动创建：

bash
# 创建空的CLAUDE.md
touch CLAUDE.md

# 让Claude分析项目并填充内容
claude "分析这个项目并更新CLAUDE.md文件"

最佳实践 ​

1. 保持更新 ​

markdown
## 最近更新

- 2024-01-15: 添加了新的API端点 /api/users
- 2024-01-14: 重构了认证模块

2. 记录决策 ​

markdown
## 架构决策

### 为什么选择PostgreSQL而不是MongoDB

- 需要复杂查询
- 数据关系紧密
- 团队熟悉SQL

### 为什么选择Prisma

- 类型安全
- 自动生成类型
- 迁移管理方便

3. 记录坑点 ​

markdown
## 常见问题

### 数据库连接超时

原因：Vercel Serverless函数有10秒限制
解决：使用连接池，复用连接

### 构建内存溢出

原因：某些页面过大
解决：在next.config.js中配置experimental.outputFileTracingExcludes

4. 环境说明 ​

markdown
## 环境配置

### 开发环境

```bash
cp .env.example .env
npm install
npm run dev

生产环境变量 ​

  • DATABASE_URL: PostgreSQL连接串
  • NEXTAUTH_SECRET: 认证密钥
  • NEXTAUTH_URL: 应用URL

5. 测试说明 ​

markdown
## 测试

### 运行测试

```bash
npm test              # 所有测试
npm test -- --watch   # 监听模式
npm test -- --coverage # 覆盖率报告

测试策略 ​

  • 单元测试：所有工具函数
  • 集成测试：API端点
  • E2E测试：关键用户流程

## 团队协作

### 提交CLAUDE.md到Git

```bash
git add CLAUDE.md
git commit -m "docs: 添加CLAUDE.md项目记忆文件"
git push

团队成员同步 ​

团队其他成员pull后，Claude自动获得相同的项目上下文。

下一步 ​

学会了CLAUDE.md配置后，继续学习 权限系统详解。