理解新代码库
快速获取代码库概览
假设您刚加入一个新项目,需要快速了解其结构。1
导航到项目根目录
2
启动 Claude Code
3
请求高层次概览
4
深入了解特定组件
提示:
- 从宽泛的问题开始,然后缩小到特定领域
- 询问项目中使用的编码约定和模式
- 请求项目特定术语的词汇表
查找相关代码
假设您需要定位与特定功能或功能相关的代码。1
请 Claude 查找相关文件
2
了解组件如何交互的上下文
3
理解执行流程
提示:
- 对您要查找的内容要具体
- 使用项目中的领域语言
高效修复错误
假设您遇到了错误消息,需要找到并修复其源头。1
与 Claude 分享错误
2
请求修复建议
3
应用修复
提示:
- 告诉 Claude 重现问题的命令并获取堆栈跟踪
- 提及重现错误的任何步骤
- 让 Claude 知道错误是间歇性的还是一致的
重构代码
假设您需要更新旧代码以使用现代模式和实践。1
识别需要重构的遗留代码
2
获取重构建议
3
安全地应用更改
4
验证重构
提示:
- 请 Claude 解释现代方法的好处
- 在需要时请求更改保持向后兼容性
- 以小的、可测试的增量进行重构
使用专门的子代理
假设您想使用专门的 AI 子代理来更有效地处理特定任务。1
查看可用的子代理
2
自动使用子代理
Claude Code 将自动将适当的任务委派给专门的子代理:
3
明确请求特定子代理
4
为您的工作流程创建自定义子代理
- 子代理类型(例如,
api-designer、performance-optimizer) - 何时使用它
- 它可以访问哪些工具
- 其专门的系统提示
提示:
- 在
.claude/agents/中创建项目特定的子代理以供团队共享 - 使用描述性的
description字段来启用自动委派 - 将工具访问限制为每个子代理实际需要的内容
- 查看子代理文档获取详细示例
使用计划模式进行安全代码分析
计划模式指示 Claude 通过只读操作分析代码库来创建计划,非常适合探索代码库、规划复杂更改或安全地审查代码。何时使用计划模式
- 多步骤实现:当您的功能需要对许多文件进行编辑时
- 代码探索:当您想在更改任何内容之前彻底研究代码库时
- 交互式开发:当您想与 Claude 就方向进行迭代时
如何使用计划模式
在会话期间开启计划模式 您可以在会话期间使用 Shift+Tab 循环切换权限模式来切换到计划模式。 如果您处于正常模式,Shift+Tab 将首先切换到自动接受模式,在终端底部显示⏵⏵ accept edits on。随后的 Shift+Tab 将切换到计划模式,显示 ⏸ plan mode on。
在计划模式下开始新会话
要在计划模式下开始新会话,请使用 --permission-mode plan 标志:
-p 直接在计划模式下运行查询(即在”无头模式”中):
示例:规划复杂重构
将计划模式配置为默认
处理测试
假设您需要为未覆盖的代码添加测试。1
识别未测试的代码
2
生成测试脚手架
3
添加有意义的测试用例
4
运行并验证测试
提示:
- 请求涵盖边缘情况和错误条件的测试
- 在适当时请求单元测试和集成测试
- 让 Claude 解释测试策略
创建拉取请求
假设您需要为您的更改创建一个文档完善的拉取请求。1
总结您的更改
2
使用 Claude 生成 PR
3
审查和完善
4
添加测试详情
提示:
- 直接请 Claude 为您创建 PR
- 在提交前审查 Claude 生成的 PR
- 请 Claude 突出潜在风险或考虑因素
处理文档
假设您需要为您的代码添加或更新文档。1
识别未文档化的代码
2
生成文档
3
审查和增强
4
验证文档
提示:
- 指定您想要的文档样式(JSDoc、docstrings 等)
- 在文档中请求示例
- 为公共 API、接口和复杂逻辑请求文档
处理图像
假设您需要在代码库中处理图像,并希望 Claude 帮助分析图像内容。1
向对话中添加图像
您可以使用以下任何方法:
- 将图像拖放到 Claude Code 窗口中
- 复制图像并使用 ctrl+v 粘贴到 CLI 中(不要使用 cmd+v)
- 向 Claude 提供图像路径。例如,“Analyze this image: /path/to/your/image.png”
2
请 Claude 分析图像
3
使用图像提供上下文
4
从视觉内容获取代码建议
提示:
- 当文本描述不清楚或繁琐时使用图像
- 包含错误截图、UI 设计或图表以获得更好的上下文
- 您可以在对话中处理多个图像
- 图像分析适用于图表、截图、模型等
引用文件和目录
使用 @ 快速包含文件或目录,无需等待 Claude 读取它们。1
引用单个文件
2
引用目录
3
引用 MCP 资源
提示:
- 文件路径可以是相对路径或绝对路径
- @ 文件引用将文件目录和父目录中的 CLAUDE.md 添加到上下文中
- 目录引用显示文件列表,而不是内容
- 您可以在单个消息中引用多个文件(例如,“@file1.js and @file2.js”)
使用扩展思考
假设您正在处理复杂的架构决策、具有挑战性的错误或需要深度推理的多步骤实现规划。扩展思考在 Claude Code 中默认禁用。您可以通过使用
Tab 切换思考开启来按需启用它,或者使用”think”或”think hard”等提示。您也可以通过在设置中设置 MAX_THINKING_TOKENS 环境变量来永久启用它。1
提供上下文并请 Claude 思考
2
通过后续提示完善思考
Claude 将在响应上方以斜体灰色文本显示其思考过程。
恢复之前的对话
假设您一直在使用 Claude Code 处理任务,需要在稍后的会话中继续之前的工作。 Claude Code 提供两个恢复之前对话的选项:--continue自动继续最近的对话--resume显示对话选择器
1
继续最近的对话
2
在非交互模式下继续
--print 与 --continue 在非交互模式下恢复最近的对话,非常适合脚本或自动化。3
显示对话选择器
- 会话摘要(或初始提示)
- 元数据:经过时间、消息计数和 git 分支
提示:
- 对话历史存储在您的机器本地
- 使用
--continue快速访问您最近的对话 - 当您需要选择特定的过去对话时使用
--resume - 恢复时,您将在继续之前看到整个对话历史
- 恢复的对话以与原始对话相同的模型和配置开始
- 对话存储:所有对话都自动保存在本地,包含完整的消息历史
- 消息反序列化:恢复时,整个消息历史被恢复以保持上下文
- 工具状态:来自之前对话的工具使用和结果被保留
- 上下文恢复:对话以所有之前的上下文完整恢复
使用 Git worktrees 运行并行 Claude Code 会话
假设您需要同时处理多个任务,并在 Claude Code 实例之间完全隔离代码。1
了解 Git worktrees
Git worktrees 允许您将同一存储库的多个分支检出到单独的目录中。每个 worktree 都有自己的工作目录和隔离的文件,同时共享相同的 Git 历史。在官方 Git worktree 文档中了解更多。
2
创建新的 worktree
3
在每个 worktree 中运行 Claude Code
4
在另一个 worktree 中运行 Claude
5
管理您的 worktrees
提示:
- 每个 worktree 都有自己独立的文件状态,使其非常适合并行 Claude Code 会话
- 在一个 worktree 中所做的更改不会影响其他 worktree,防止 Claude 实例相互干扰
- 所有 worktrees 共享相同的 Git 历史和远程连接
- 对于长时间运行的任务,您可以让 Claude 在一个 worktree 中工作,同时在另一个 worktree 中继续开发
- 使用描述性目录名称轻松识别每个 worktree 用于哪个任务
- 记住根据项目的设置在每个新 worktree 中初始化您的开发环境。根据您的技术栈,这可能包括:
- JavaScript 项目:运行依赖项安装(
npm install、yarn) - Python 项目:设置虚拟环境或使用包管理器安装
- 其他语言:遵循项目的标准设置过程
- JavaScript 项目:运行依赖项安装(
将 Claude 用作 unix 风格的实用程序
将 Claude 添加到您的验证过程中
假设您想将 Claude Code 用作 linter 或代码审查器。 将 Claude 添加到您的构建脚本中:提示:
- 在您的 CI/CD 管道中使用 Claude 进行自动化代码审查
- 自定义提示以检查与您项目相关的特定问题
- 考虑为不同类型的验证创建多个脚本
管道输入,管道输出
假设您想将数据管道输入到 Claude,并以结构化格式获取数据。 通过 Claude 管道数据:提示:
- 使用管道将 Claude 集成到现有的 shell 脚本中
- 与其他 Unix 工具结合使用以实现强大的工作流程
- 考虑使用 —output-format 进行结构化输出
控制输出格式
假设您需要 Claude 的输出采用特定格式,特别是在将 Claude Code 集成到脚本或其他工具中时。1
使用文本格式(默认)
2
使用 JSON 格式
3
使用流式 JSON 格式
提示:
- 对于只需要 Claude 响应的简单集成,使用
--output-format text - 当您需要完整的对话日志时使用
--output-format json - 对于每个对话轮次的实时输出,使用
--output-format stream-json
创建自定义斜杠命令
Claude Code 支持自定义斜杠命令,您可以创建这些命令来快速执行特定提示或任务。 有关更多详情,请参阅斜杠命令参考页面。创建项目特定命令
假设您想为项目创建可重用的斜杠命令,所有团队成员都可以使用。1
在项目中创建命令目录
2
为每个命令创建 Markdown 文件
3
在 Claude Code 中使用您的自定义命令
提示:
- 命令名称来自文件名(例如,
optimize.md变成/optimize) - 您可以在子目录中组织命令(例如,
.claude/commands/frontend/component.md创建/component,在描述中显示”(project:frontend)”) - 项目命令对克隆存储库的每个人都可用
- Markdown 文件内容成为调用命令时发送给 Claude 的提示
使用 $ARGUMENTS 添加命令参数
假设您想创建可以接受用户额外输入的灵活斜杠命令。1
使用 $ARGUMENTS 占位符创建命令文件
2
使用带有问题编号的命令
在您的 Claude 会话中,使用带参数的命令。这将在提示中用”123”替换 $ARGUMENTS。
提示:
- $ARGUMENTS 占位符被命令后面的任何文本替换
- 您可以在命令模板中的任何位置放置 $ARGUMENTS
- 其他有用的应用:为特定函数生成测试用例、为组件创建文档、审查特定文件中的代码或将内容翻译为指定语言
创建个人斜杠命令
假设您想创建在所有项目中都有效的个人斜杠命令。1
在您的主文件夹中创建命令目录
2
为每个命令创建 Markdown 文件
3
使用您的个人自定义命令
提示:
- 个人命令在使用
/help列出时在其描述中显示”(user)” - 个人命令仅对您可用,不与您的团队共享
- 个人命令在您的所有项目中都有效
- 您可以将这些用于跨不同代码库的一致工作流程
询问 Claude 关于其功能
Claude 内置访问其文档,可以回答关于其自身功能和限制的问题。示例问题
Claude 为这些问题提供基于文档的答案。对于可执行示例和实际演示,请参考上面的特定工作流程部分。
提示:
- Claude 始终可以访问最新的 Claude Code 文档,无论您使用的版本如何
- 提出具体问题以获得详细答案
- Claude 可以解释复杂功能,如 MCP 集成、企业配置和高级工作流程
下一步
Claude Code 参考实现
克隆我们的开发容器参考实现。