Claude Code 最佳实践

1、设置

1.1.初始化项目

  • 启动 Claude Code

    claude

  • 运行一个简单命令

    > summarize this project

  • 初始化项目,运行 /init 命令时,Claude 会自动生成一个 CLAUDE.md 文件

    /init 

    enter image description here

1.2.CLAUDE.md 作用说明

CLAUDE.md 是一个特殊文件,Claude 在启动会话时会自动将其内容拉入上下文,因此非常适合用于记录以下信息:- 常用 Bash 命令(如 npm run build)
  • 核心文件和工具函数

  • 代码风格

  • 测试说明

  • 仓库规则(如分支命名)

  • 开发环境设置(如 env 使用说明)

  • 项目特定的注意事项或警告

  • 其他希望 Claude 记住的信息

CLAUDE.md 文件没有固定的格式要求,但建议保持简洁且易于阅读。例如:
# Bash 命令
- npm run build: 构建项目
- npm run typecheck: 运行类型检查

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

# 工作流程
- 完成一系列代码更改后务必运行类型检查
- 为提升性能,优先运行单个测试而非整个测试套件

1.3.优化 CLAUDE.md 文件

CLAUDE.md 文件的内容会成为 Claude 提示的一部分,因此需要像优化常用提示一样对其进行调整。常见错误是添加大量内容却不迭代验证其效果。建议用户:

  • 实验和迭代:花时间测试,找到能让模型更好地遵循指令的内容。

  • 动态更新:手动编辑 CLAUDE.md,或使用 # 键让 Claude 自动将指令添加到文件中。使用 # 来记录命令、文件和风格指南,并通过提交更改与团队共享。

  • 增强指令:如添加“IMPORTANT”或“YOU MUST”等强调词,以提高模型的指令遵循能力。

 

作者:admin  创建时间:2025-07-09 18:16
最后编辑:admin  更新时间:2025-07-09 19:09