Claude Code官方最佳实践

示例代码

📎 附件：claude-practices.zip（zip, 11KB）

原文链接：https://www.yuque.com/attachments/yuque/0/2025/zip/2424104/1755660648524-55b8ce80-1a9e-4ecc-b847-07330261340b.zip

前言

​Claude Code，一个用于智能体编程的命令行工具。
作为一个内部实验性项目，Claude Code为Anthropic的工程师和研究人员提供了一种更原生的方式来将Claude集成到他们的编程工作流程中。

Claude Code被有意设计为low-level（低级别）且unopinionated（无特定偏好），提供接近原始模型的访问权限，而不强制使用特定的工作流程。
这种设计哲学创造了一个灵活、可定制、可脚本化且安全的强大工具。
虽然功能强大，但这种灵活性为初次接触智能体编程工具的工程师带来了学习曲线 —— 至少直到他们形成自己的最佳实践。

本文档概述了已被证明有效的通用模式，无论是对于Anthropic的内部团队，还是对于在各种代码库、语言和环境中使用Claude Code的外部工程师。
此列表中的内容都不是一成不变的，也不普遍适用；请将这些建议视为起点。我们鼓励您进行实验，找到最适合您的方法！

寻找更详细的信息？我们在claude.ai/code的综合文档*涵盖了本文提到的所有功能，并提供了额外的示例、实现细节和高级技术。*

1. 自定义您的设置

Claude Code是一个智能体编程助手，会自动将上下文拉入提示中。这种上下文收集会消耗时间和令牌，但您可以通过环境调优来优化它。

a. 创建CLAUDE.md文件

CLAUDE.md是一个特殊文件，Claude在开始对话时会自动将其拉入上下文。这使其成为记录以下内容的理想场所：

• 常用bash命令
• 核心文件和实用函数
• 代码风格指南
• 测试说明
• 代码库规范（例如，分支命名、合并与变基等）
• 开发环境设置（例如，pyenv使用、哪些编译器有效）
• 项目特有的任何意外行为或警告
• 您希望Claude记住的其他信息

CLAUDE.md文件没有要求的格式。我们建议保持简洁且人类可读。例如：

# Bash命令
- npm run build: 构建项目
- npm run typecheck: 运行类型检查器

# 代码风格
- 使用ES模块 (import/export) 语法，而不是CommonJS (require)
- 尽可能使用解构导入 (例如 import { foo } from 'bar')

# 工作流程
- 在完成一系列代码更改后务必进行类型检查
- 为了性能考虑，优先运行单个测试，而不是整个测试套件

您可以将CLAUDE.md文件放置在几个位置：

• 代码库的根目录，或您运行claude的任何地方（最常见的用法）。将其命名为CLAUDE.md并将其检入git，这样您就可以在会话间和团队成员间共享（推荐），或将其命名为CLAUDE.local.md并将其添加到.gitignore中
• 您运行claude的目录的任何父目录。这对于monorepo最有用，您可能从root/foo运行claude，并在root/CLAUDE.md和root/foo/CLAUDE.md中都有CLAUDE.md文件。这两个文件都会自动拉入上下文
• 您运行claude的目录的任何子目录。这与上述相反，在这种情况下，当您处理子目录中的文件时，Claude会按需拉入CLAUDE.md文件
• 您的主文件夹（~/.claude/CLAUDE.md），这会将其应用到所有您的claude会话

当您运行/init命令时，Claude会自动为您生成一个CLAUDE.md文件。

b. 调优您的CLAUDE.md文件

您的CLAUDE.md文件会成为Claude提示的一部分，因此应该像任何经常使用的提示一样进行精心完善。一个常见的错误是添加大量内容而不迭代其有效性。请花时间实验并确定什么能产生模型最佳的指令遵循效果。

您可以手动向CLAUDE.md添加内容，或按#键给Claude一个指令，它会自动将其纳入相关的CLAUDE.md中。许多工程师在编码时频繁使用#来记录命令、文件和风格指南，然后在提交中包含CLAUDE.md的更改，以便团队成员也能受益。

在Anthropic，我们偶尔会通过提示词改进器运行CLAUDE.md文件，并经常调优指令（例如，添加"重要"或"您必须"的强调）以提高遵循度。