Claude Code Guide 旨在为配置和使用 Claude Code(智能体式编程工具)提供一个全面的参考,将最佳实践、配置模板与高级用法模式整合在一起。
用途
该指南用于帮助用户充分发挥 Claude Code 的能力,覆盖从项目初始化配置到提示词编写、再到问题调试的完整使用链路。
配置(CLAUDE.md)
在新项目开始时,应在根目录创建 CLAUDE.md 文件来引导智能体。资料提供的通用模板包含以下部分:
项目准则(# Project Guidelines)
命令(Commands)
- 运行应用:npm run dev
- 测试:npm test
- 构建:npm run build
代码风格(Code Style)
- 所有新代码使用 TypeScript。
- React 使用带 Hooks 的函数式组件。
- 使用 Tailwind CSS 进行样式设计。
- 错误处理采用早期返回(early returns)。
工作流(Workflow)
- 先阅读 README.md 以理解项目上下文。
- 编辑前先读取文件内容。
- 编辑后运行测试进行验证。
高级功能
Thinking 关键词
在提示词中使用以下关键词,可触发智能体更深层的推理:
- 「Think step-by-step」
- 「Analyze the root cause」
- 「Plan before executing」
- 「Verify your assumptions」
调试
如果智能体卡住或行为异常,可以采用以下方法:
- 清理上下文:开启新会话,或在智能体混乱时要求它「forget previous instructions」。
- 明确指令:对路径、文件名和期望结果给出极其具体的说明。
- 日志:要求智能体「check the logs」或以 verbose 输出运行命令。
最佳实践
- 小型上下文:不要把整个代码库塞进上下文,先用
grep或find定位相关文件。 - 迭代开发:请求小改动,验证后再继续。
- 反馈闭环:如果智能体出错,立即纠正,并要求它将经验教训「add a lesson」加入其记忆(如支持)或 CLAUDE.md。
参考
该指南基于 zebbern 的 Claude Code Guide(https://github.com/zebbern/claude-code-guide)。
适用场景与限制
上述内容适用于使用 Claude Code 进行项目配置、提示词设计与调试的开发者。资料未提供该技能的具体安装命令、收费方式、支持平台或效果数据,这些信息暂未提供。