极客前沿

手把手教你写 CLAUDE.md:AI 编程助手入门教程

2026-07-16 01:30
Real Python
查看原文

从零开始学习如何为 Claude Code 编写 CLAUDE.md 文件,通过简单步骤设置全局、项目和本地规则,让 AI 助手更懂你的代码习惯。

本教程面向零基础读者,教你如何为 Claude Code(一款 AI 编程助手)编写 CLAUDE.md 文件,让 AI 更准确地理解你的项目需求。你不需要任何 AI 或编程基础,跟着步骤走就能学会。

Tutorial Image

准备环境:你需要装什么?

  • Claude Code:这是 AI 助手,需要先安装。去官网下载并按照指引完成安装。
  • 文本编辑器:用来写 CLAUDE.md 文件,推荐用 VS Code 或任何你喜欢的编辑器。
  • Python 项目:一个你熟悉的小项目(比如一个简单的脚本)。如果没有,可以下载一个示例脚本跟着学。
  • 注意:确保你的项目已经配置好依赖、测试和代码格式化工具,这样 AI 才能更好地工作。

安装步骤:一步步来

  1. 安装 Claude Code:根据官方文档完成安装,确保命令行能运行 claude 命令。
  2. 准备项目文件夹:在你的项目根目录下,创建一个名为 CLAUDE.md 的文件(注意文件名全大写)。
  3. 编写全局规则(可选):在用户主目录下创建 ~/.claude/CLAUDE.md,写入你个人常用的 Python 命令和习惯,比如测试命令、代码风格等。
  4. 编写项目规则:在项目的 CLAUDE.md 中,记录 AI 容易犯错的地方。例如,如果你的项目使用 AWS Bedrock,可以写“使用 inferenceProfileId 而不是 modelId 来启用全局跨区域推理”。
  5. 编写本地笔记(可选):在 .gitignore 中添加 CLAUDE.local.md,然后创建该文件,存放不想提交到版本控制的个人偏好。

验证是否成功:测试你的设置

  • 运行一次任务:在项目目录下执行 claude 命令,给它一个小任务,比如“运行测试”或“解释这个函数”。
  • 观察错误:如果 AI 犯了重复错误,比如建议了错误的代码写法,就把这个修正写进 CLAUDE.md。
  • 注意:不要写太多规则,只记录 AI 无法从代码仓库推断出来的内容,否则会浪费资源。

下一步可以做什么

  • 优化规则:随着使用,不断调整 CLAUDE.md,让 AI 更聪明。
  • 学习更多:尝试为不同项目编写规则,或者研究如何用 /init 命令自动生成初始文件。
  • 注意坑:自动生成的 CLAUDE.md 往往太长,记得精简,只保留必要内容。

内容来源

Real Python

发布时间

2026-07-16 01:30

返回 AI技术