Tips
克劳德·姆德(签名) 最佳做法: 为任何工程配置 Claude 代码
CLAUDE.md是Claude Code唯一最有影响力的配置. 一个写得很好的版本将通用AI援助变成具体项目的专门知识.
CLAUDE.md是您项目根部的平分文件. Claude Code在每次会话开始时 都会在输入之前读出来 一个很好的克劳德。 md将通用AI转换成理解您项目常规的工具,技术堆栈和红线.
你该加入什么?
重点关注聪明的开发人员加入您的团队第一天所需的信息。保持实用:技术堆栈、命令、约定和要避免的事情。
最小 CLAUDE.md 模板
# Project Context
Next.js 14 app with TypeScript, Tailwind CSS, and Prisma.
Database: PostgreSQL. Auth: NextAuth.js.
## Commands
- `npm run dev` — start dev server (port 3000)
- `npm run test` — run Jest tests
- `npm run lint` — run ESLint
- `npm run db:migrate` — run Prisma migrations
## Architecture
- Server components by default, client components in /components/client/
- API routes in /app/api/ with Zod validation
- Database queries in /lib/db/ (never in components)
## Conventions
- TypeScript strict mode, never use `any`
- Tailwind for styling, no CSS modules
- Conventional commits: feat:, fix:, chore:
## Do NOT
- Modify files in /legacy/ or /vendor/
- Change auth configuration without explicit approval
- Add new dependencies without asking first最常见的 CLAUDE.md 错误有哪些?
| 错误 | 为什么会痛 | 使固定 |
|---|---|---|
| 太长(500 行以上) | 在每个会话上浪费上下文窗口 | 保持在200行以下, 详情请与文件链接 |
| 太模糊了 (“ 写干净代码 ” ) | 没有可操作的指导 | 具体:"默认使用服务器组件" |
| 缺少命令 | 克劳德猜怎么运行/测试/建设 | 列出每个相关的 npm 脚本 |
| 无限制 | Claude 可以修改敏感文件 | 添加一个清晰的“ 不做” 部分 |
| 自述文件的副本 | README 适用于人类,CLAUDE.md 适用于 AI | 关注约定和规则,而不是项目描述 |
如何为大型项目构建 CLAUDE.md?
对于大型代码库,请使用 @import 语法跨目录拆分配置。 Claude Code 遵循导入并构建完整的图景。
# Root CLAUDE.md
## Global conventions
- TypeScript strict, no `any`
- All API routes validate input with Zod
@import packages/api/CLAUDE.md
@import packages/web/CLAUDE.md
@import packages/shared/CLAUDE.md每个子 CLAUDE.md 都包含特定于该包的规则。这使得根文件很短,同时为 Claude Code 提供了有关代码库每个区域的深入上下文。
如何自动生成CLAUDE.md?
Claude Code 可以通过分析您的项目来生成起始的 CLAUDE.md:
# Auto-generate CLAUDE.md
claude /init
# This creates a CLAUDE.md based on:
# - package.json scripts
# - Project structure
# - Existing config files
# - Git history patternsCLAUDE.md 内存层次结构怎么样?
Claude Code 按优先级顺序从多个位置读取 CLAUDE.md 文件:
- +项目根 CLAUDE.md(团队中的每个人都共享此)
- +子目录 CLAUDE.md 文件(通过@import)
- +~.claude/CLAUDE.md(你个人的全球喜好)
- +自动内存( MEMORY. md,由/memory 命令管理)
项目级别设置高于个人设置 。 这意味着团队大会总是胜过个人偏好.