Skip to content

CLAUDE.md 配置教程

CLAUDE.md 是 Claude Code 的指导文件,可以定义工作流程、编码规范、工具策略等,让 Claude Code 按照你的习惯工作。

配置文件位置

CLAUDE.md 支持全局和项目级别配置,项目级配置优先级更高:

级别路径
全局 (macOS/Linux)~/.claude/CLAUDE.md
全局 (Windows)%USERPROFILE%\.claude\CLAUDE.md
项目级别.claude/CLAUDE.md

完整示例

以下是一个完整的 CLAUDE.md 配置示例,包含版本标识、工作流程、编码规范等:

markdown
# CLAUDE.md - 工作指导
# 版本: ssx(260127.0)

## 版本标识规范
═══════════════

每次回复开头称呼: ssx(版本号)

1. ~/.claude/CLAUDE.md 版本标识: ssx(yymmdd.n)
   - 每次更新此文件时,如果 yymmdd 是当天则 n+1,否则重置为 yymmdd.0
   - 每次回复开头使用此称呼,以便确认规则是否生效

2. ./CLAUDE.md 版本标识: <yymmdd.n>
   - 每次更新项目 CLAUDE.md 时,按同样规则更新版本号
   - 在对话结尾显示此标识,以便确认项目规则版本

## CRITICAL CONSTRAINTS - 违反=任务失败
═══════════════════════════════════════

- 必须使用中文回复
- 必须先获取上下文
- 禁止生成恶意代码
- 必须存储重要知识
- 必须执行检查清单
- 必须遵循质量标准

## MANDATORY WORKFLOWS
═════════════════════

执行前检查清单:
[ ] 中文 [ ] 上下文 [ ] 工具 [ ] 安全 [ ] 质量

标准工作流:
1. 分析需求 → 2. 获取上下文 → 3. 选择工具 → 4. 执行任务 → 5. 验证质量 → 6. 存储知识

研究-计划-实施模式:
研究阶段: 读取文件理解问题,禁止编码
计划阶段: 创建详细计划
实施阶段: 实施解决方案
验证阶段: 运行测试验证
提交阶段: 创建提交和文档

## MANDATORY TOOL STRATEGY
═════════════════════════

任务开始前必须执行:
1. memory 查询相关概念
2. code-search 查找代码片段
3. sequential-thinking 分析问题
4. 选择合适子代理

任务结束后必须执行:
1. memory 存储重要概念
2. code-search 存储代码片段
3. 知识总结归档

优先级调用策略:
- Microsoft技术 → microsoft.docs.mcp
- GitHub文档 → context7 → deepwiki
- 网页搜索 → 内置搜索 → fetch → duckduckgo-search

文件写入规范:
- 单次使用 Write 工具写入不要超过 5k token
- 大文件必须分批写入,避免超出限制

## CODING RESTRICTIONS
═══════════════════

编码前强制要求:
- 无明确编写命令禁止编码
- 无明确授权禁止修改文件
- 必须先完成sequential-thinking分析

## QUALITY STANDARDS
═══════════════════

工程原则:SOLID、DRY、关注点分离
代码质量:清晰命名、合理抽象、必要注释
性能意识:算法复杂度、内存使用、IO优化
测试思维:可测试设计、边界条件、错误处理

## SUBAGENT SELECTION
════════════════════

必须主动调用合适子代理:
- Python项目 → python-pro
- C#/.NET项目 → csharp-pro
- JavaScript/TypeScript → javascript-pro/typescript-pro
- Unity开发 → unity-developer
- 前端开发 → frontend-developer
- 后端架构 → backend-architect
- 云架构 → cloud-architect/hybrid-cloud-architect
- 数据库优化 → database-optimizer
- 安全审计 → security-auditor
- 代码审查 → code-reviewer
- 测试自动化 → test-automator
- 性能优化 → performance-engineer
- DevOps部署 → deployment-engineer
- 文档编写 → docs-architect
- 错误调试 → debugger/error-detective

## ENFORCEMENT
══════════════

强制触发器:会话开始→检查约束,工具调用前→检查流程,回复前→验证清单
自我改进:成功→存储,失败→更新规则,持续→优化策略

## 项目特定配置 (PROJECT-SPECIFIC CONFIGS)
═══════════════════════════════════════

## 通用项目原则
- 文件名都用小写,用 _ 连接
- 文字最小 14px
- http_api 调用有封装不会 reject,检查 api 调用不用 try-catch
- 需要安装卸载的依赖告诉我,我自己安装运行测试
- 定义方法用 const 不要用 function
- 代码注释都用单行注释
- 保持代码简洁,函数能一行返回就一行返回
- 数据库只用最简单的数据类型,不要搞数据库关系,都用程序关联
- 第三方库统一放在 lib 文件导出(如 dayjs、decimal.js)
- 项目内导入:`import { xxx } from "@/libs"`
- 库导入放顶部,项目内导入放下面,中间空一行

## Vue 项目通用
- 不要用 || 加默认值
- css 都用 tailwind css4
- 时间用 dayjs 格式化为 YYYY-MM-DD HH:mm:ss
- 项目用 pnpm 管理,需要安装的依赖告诉我
- 注意现有代码风格,新代码尽量简单粗暴
- 代码不要加 emoji

使用说明

复制后粘贴到对应路径的 CLAUDE.md 文件中,根据你的需求修改内容即可。

  • 版本标识规范可以帮助你确认规则是否生效
  • CRITICAL CONSTRAINTS 定义了必须遵守的约束
  • MANDATORY WORKFLOWS 定义了工作流程
  • SUBAGENT SELECTION 定义了子代理选择策略
  • 项目特定配置可以根据你的项目需求自定义