AI编程速查手册
567 字
3 分钟
AI编程速查手册
CLAUDE.md 编写规范
Claude Code 的项目级指令文件,放项目根目录,会话启动时自动读取。本质是”给 AI 看的项目交接文档”。 参考:Anthropic 官方文档
文件层级与优先级
| 文件位置 | 作用域 | 优先级 |
|---|---|---|
~/.claude/CLAUDE.md | 全局所有项目 | 低 |
项目根目录/CLAUDE.md | 当前项目 | 中 |
子目录/CLAUDE.md | 当前子目录 | 高 |
高优先级覆盖低优先级。编写三原则:精简为王、可执行、结构化。
核心结构
# 项目名称 — 一句话定位├── 项目概述 ← 做什么、解决什么├── 技术栈 ← 语言/框架/版本/约束├── 项目结构 ← 目录树 + 关键目录职责├── 编码规范 ← 风格/命名/提交/禁止事项├── 构建与运行 ← install/dev/build/test 命令├── 当前进度 ← Checkbox 三档├── 注意事项 ← 踩坑(现象→原因→解法)+ 特殊约定└── 测试说明 ← 跑测试方式、覆盖率要求最短模板骨架
# 项目名 — 一句话定位
# 项目概述做什么 + 核心特性(2~3 句)
# 技术栈| 类别 | 技术 | 版本 | 备注 |
# 项目结构├── src/ ... # 职责└── package.json
# 编码规范- 风格:缩进2空格 / 单引号 / 无分号- 命名:文件PascalCase / 变量camelCase / 常量UPPER_SNAKE- 禁止:❌ any / ❌ 内联样式
# 构建与运行pnpm install / pnpm dev / pnpm build / pnpm test
# 当前进度- [x] ... [ ] ... [ ] ...
# 注意事项- 踩坑:现象→原因→解法- 约定:特殊规则LLM LOOP
AGENT 的工作原理:Claude Code 的工作方式:你下达一个目标→cc 自己拆解步骤→自己调用工具→看结果→决定下一步→再调用工具→ 一直循环到任务完成。主动权交给了 AI。这个不断“思考-行动-观察-再思考”的循环,就叫 LLM Loop。
Harness
CLAUDE.MD—HOOKS—SKILLS—PLUGINS—LSP—MCP—SUBAGENTS
三层记忆
Claude.md—Auto Memory—SPEC/PLAN/API/PROCESS.md(项目约定规范) .cluadeignore
/node_modules.envdist/*.log.next/速查陌生命令
!npm run dev #(bash)/btw (不污染上下文的提无关问题)/resume 历史会话回复/init/cost/status 查看模型/状态等/simplify 优化/remind 撤回工作流 workflow
周期:explore—plan—implement-(review)-commit
支持与分享
如果这篇文章对你有帮助,欢迎分享给更多人或赞助支持!