claude code使用之初始化(三)
Claudecode项目通过/init命令自动生成CLAUDE.md文件,该文件作为AI的"使用说明书"包含项目基本信息(技术栈、结构)、开发规范和工作流程。采用迭代优化方式,在对话中用#前缀持续更新内容。高阶用法包括:角色定制(定义AI身份)、项目结构约定、关键文件索引、工作流程规则和避坑经验。CLAUDE.md确保每次对话都能预先加载项目上下文,提高协作效率。
一、claude code项目初始化
claude code 项目初始化可以在交互界面中输入,或者在ide的对话框中输入命令
/init
这是claude会自动扫描你的代码库,读取当前目录下的文档、配置文件以及代码结构,然后生成一份专属于你项目的CLAUDE.md文件。整个过程都是claude自动完成,无需认为干预。
二、CLAUDE.md文件
1.CLAUDE.md文件基本信息
CLAUDE.md文件是一个放在个根目录的markdown文件,claude code在每次会话开始时会自动读取。CLAUDE.md文件时claude系统提示的一部分,使每次对话都能预先加载项目上下文,不再需要重复解释基本信息。内容尽可能的少,精炼。
Claude.md = 给 AI 的 “使用说明书 + 行为准则 + 索引目录”,
一份好的 CLAUDE.md 应该覆盖三个维度:
- WHAT(是什么):项目用途,技术栈、项目结构,为 Claude 提供代码库的全局地图
- WHY(为什么):项目的目的,各模块的功能与定位
- HOW(怎么做):开发方式,例如使用 bun 而非 node,以及 Claude 如何验证改动是否正确 Humanlayer
初始化的最佳实践是迭代优化,而非一次写死。
2.使用#快捷键持续更新
在对话过程中,随时使用#前缀给claude发送记忆指令
# 我们始终使用 pnpm,不用 npm
# 所有组件必须包含单元测试
这些补充会逐步积累,形成一份真正反应实际工作方式的CLAUDE.md文件。
3.一些高阶的用法(有一些是个人理解,有可能有不对的地方):
(1)角色定制(Persona)
让 AI 成为你的专属专家,可以给claude code定义AI身份,比如:
- 你的技术栈
- 你的风格偏好
- 禁止废话、直接给代码、优先最简方案等
Persona: 你是一位精通 Python、Django、Vue 的全栈架构师,说话简洁,只给可运行的代码,拒绝废话。
(2)项目结构约定(必须是极简版)
项目结构约定:
- src/ 前端代码
- api/ 后端接口
- config/ 配置文件
- docs/ 文档目录
(3)关键路径的索引
重要文件路径:
- 数据库结构:docs/schema.md
- 接口文档:docs/api.md
- 开发规范:docs/rules.md
- 常见问题:docs/debug.md
(4)工作流规则(流程,不是内容)
工作流:
1. 先查看项目结构
2. 遇到问题优先查 docs/debug.md
3. 不随意覆盖文件
4. 报错先定位行号再修复
(5)避坑经验(简短条目)
在每次debug后,添加一句,将debug的经验言简意赅的写入到claude.md文件中。
历史踩坑提醒:
- 环境切换后必须重启 VSCode
- 打包前先清 dist
- SQLite 避免并发写入
- Vue 跨域必须带 credentials
更多推荐
所有评论(0)