Common workflows
- 分组:一、官方文档
- 原始链接:https://code.claude.com/docs/en/common-workflows
- 抓取来源:http://code.claude.com/docs/en/common-workflows
- 原始文件:/Users/yuanruiqin/Desktop/知识库/ClaudeCode-系统化知识库/01-官方文档/07-common-workflows.md
- 精读版生成时间:2026-04-05 13:50:44
中文精读版(去噪)
常见工作流程 - Claude 代码文档
Claude Code Docs 主页!图片 1:光徽标!图2:黑暗标志
⌘K问AI
克劳德开发者平台 网络上的克劳德代码
使用克劳德代码
常见工作流程
入门与 Claude 一起构建代码部署管理配置参考什么新资源
开始使用
概述 快速入门 变更日志
核心概念
Claude Code 的工作原理 扩展克劳德代码 探索 .claude 目录 探索上下文窗口
使用克劳德代码
平台和集成
示例:规划复杂的重构 使用 Git 工作树运行并行 Claude Code 会话 使用 Claude 作为 unix 风格的实用程序
使用克劳德代码
常用工作流程
使用 Claude Code 探索代码库、修复错误、重构、测试和其他日常任务的分步指南。
本页面涵盖了日常开发的实用工作流程:探索不熟悉的代码、调试、重构、编写测试、创建 PR 和管理会话。每个部分都包含示例提示,您可以根据自己的项目进行调整。有关更高级别的模式和技巧,请参阅最佳实践。
了解新的代码库
快速了解代码库概述
假设您刚刚加入一个新项目,需要快速了解其结构。
cd /路径/到/项目
启动克劳德代码
克劳德
请求高级概述
给我这个代码库的概述
深入研究特定组件
解释这里使用的主要架构模式
关键的数据模型是什么?
身份验证是如何处理的?
温馨提示: 从广泛的问题开始,然后缩小到特定领域 询问项目中使用的编码约定和模式 索取项目特定术语表
查找相关代码
假设您需要查找与特定特性或功能相关的代码。
请克劳德找到相关文件
查找处理用户身份验证的文件
获取有关组件如何交互的上下文
这些身份验证文件如何协同工作?
了解执行流程
温馨提示: 具体说明您要寻找的内容 使用项目中的领域语言
高效修复错误
假设您遇到错误消息并需要查找并修复其来源。
与克劳德分享错误
运行 npm test 时出现错误
寻求修复建议
建议一些方法来修复 user.ts 中的 @ts-ignore
应用修复
更新 user.ts 以添加您建议的空检查
温馨提示: 告诉 Claude 命令来重现问题并获取堆栈跟踪 提及重现错误的任何步骤 让 Claude 知道错误是间歇性的还是持续性的
重构代码
假设您需要更新旧代码以使用现代模式和实践。
识别遗留代码以进行重构
在我们的代码库中查找已弃用的 API 用法
获取重构建议
建议如何重构 utils.js 以使用现代 JavaScript 功能
安全地应用更改
重构 utils.js 以使用 ES2024 功能,同时保持相同的行为
验证重构
对重构的代码运行测试
温馨提示: 请克劳德解释现代方法的好处 请求更改在需要时保持向后兼容性 以小的、可测试的增量进行重构
使用专门的子代理
假设您想使用专门的 AI 子代理来更有效地处理特定任务。
查看可用的子代理
/代理商
这会显示所有可用的子代理并允许您创建新的子代理。
自动使用子代理
Claude Code 自动将适当的任务委托给专门的子代理:
检查我最近的代码更改是否存在安全问题
运行所有测试并修复任何故障
明确请求特定的子代理
使用 code-reviewer 子代理检查 auth 模块
为您的工作流程创建自定义子代理
/代理商
然后选择“Create New subagent”并按照提示进行定义: 描述子代理用途的唯一标识符(例如,“code-reviewer”、“api-designer”)。 克劳德何时应该使用该药剂 它可以访问哪些工具 描述座席角色和行为的系统提示
温馨提示:
在.claude/agents/中创建特定于项目的子代理以供团队共享
使用描述性“描述”字段来启用自动委派
限制工具访问每个子代理实际需要的内容
查看 subagents 文档 了解详细示例
使用计划模式进行安全代码分析
计划模式指示 Claude 通过使用只读操作分析代码库来创建计划,非常适合探索代码库、规划复杂的更改或安全地审查代码。在计划模式下,Claude 在提出计划之前使用 AskUserQuestion 来收集需求并阐明您的目标。
何时使用计划模式
多步骤实施:当您的功能需要对多个文件进行编辑时 代码探索:当您想在更改任何内容之前彻底研究代码库时 交互式开发:当你想与 Claude 一起迭代方向时
如何使用计划模式
在会话期间打开计划模式您可以在会话期间使用 Shift+Tab 切换到计划模式以循环切换权限模式。如果您处于正常模式,Shift+Tab 首先切换到自动接受模式,由终端底部的“⏵⏵接受编辑”指示。随后的 Shift+Tab 将切换到计划模式,由 ⏸ plan mode on 指示。在计划模式下启动新会话要在计划模式下启动新会话,请使用 --permission-mode plan 标志:
克劳德——许可模式计划
在计划模式下运行“无头”查询您还可以直接使用“-p”在计划模式下运行查询(即在“无头模式”):
claude --permission-mode plan -p“分析身份验证系统并提出改进建议”
示例:规划复杂的重构
克劳德——许可模式计划
我需要重构我们的身份验证系统以使用 OAuth2。制定详细的迁移计划。
克劳德分析了当前的实施情况并制定了全面的计划。完善后续行动:
向后兼容性怎么样?
我们应该如何处理数据库迁移?
按“Ctrl+G”在默认文本编辑器中打开该计划,您可以在克劳德继续之前直接对其进行编辑。
当您接受计划时,Claude 会自动根据计划内容命名会话。该名称显示在提示栏和会话选择器中。如果您已经使用“--name”或“/rename”设置了名称,接受计划不会覆盖它。
将计划模式配置为默认模式
// .claude/settings.json “权限”:{ “默认模式”:“计划”
有关更多配置选项,请参阅设置文档。
处理测试
假设您需要为未覆盖的代码添加测试。
识别未经测试的代码
查找NotificationsService.swift中测试未涵盖的函数
生成测试脚手架
添加通知服务测试
添加有意义的测试用例
在通知服务中添加边缘条件的测试用例
运行并验证测试
运行新测试并修复任何故障
Claude 可以生成遵循项目现有模式和约定的测试。当要求进行测试时,请具体说明您想要验证的行为。 Claude 检查您现有的测试文件,以匹配已使用的样式、框架和断言模式。为了全面覆盖,请要求 Claude 识别您可能错过的边缘情况。 Claude 可以分析您的代码路径,并建议对错误条件、边界值和容易忽视的意外输入进行测试。
创建拉取请求
您可以通过直接询问 Claude(“为我的更改创建 pr”)来创建拉取请求,或者引导 Claude 逐步完成:
总结一下你的改变
总结我对身份验证模块所做的更改
生成拉取请求
创建公关
审查和完善
通过更多有关安全改进的上下文来增强 PR 描述
当您使用“gh pr create”创建 PR 时,会话会自动链接到该 PR。您可以稍后使用“claude --from-pr ”恢复它。
在提交之前查看 Claude 生成的 PR,并要求 Claude 强调潜在的风险或注意事项。
处理文档
假设您需要添加或更新代码的文档。
识别未记录的代码
在 auth 模块中查找没有正确 JSDoc 注释的函数
生成文档
将 JSDoc 注释添加到 auth.js 中未记录的函数中
回顾并加强
使用更多上下文和示例改进生成的文档
验证文档
检查文档是否符合我们的项目标准
温馨提示: 指定您想要的文档样式(JSDoc、文档字符串等) 询问文档中的示例 请求公共 API、接口和复杂逻辑的文档
处理图像
假设您需要处理代码库中的图像,并且需要 Claude 帮助分析图像内容。
在对话中添加图像
您可以使用以下任一方法:
- 将图像拖放到 Claude Code 窗口中
- 复制图像并使用 ctrl+v 将其粘贴到 CLI 中(请勿使用 cmd+v)
- 向 Claude 提供图像路径。例如,“分析此图像:/path/to/your/image.png”
请克劳德分析图像
这张图片显示了什么?
描述此屏幕截图中的 UI 元素
该图中是否存在任何有问题的元素?
使用图像作为上下文
这是错误的屏幕截图。是什么原因造成的?
这是我们当前的数据库架构。我们应该如何修改它以适应新功能?
从视觉内容中获取代码建议
生成 CSS 以匹配此设计模型
什么样的 HTML 结构可以重新创建这个组件?
温馨提示: 当文字描述不清楚或繁琐时使用图像 包括错误屏幕截图、UI 设计或图表以获得更好的上下文 您可以在对话中处理多个图像 图像分析适用于图表、屏幕截图、模型等 当 Claude 引用图像(例如,“[Image #1]”)时,“Cmd+Click”(Mac) 或“Ctrl+Click”(Windows/Linux) 用于在默认查看器中打开图像的链接
参考文件和目录
使用@可以快速包含文件或目录,而无需等待Claude读取它们。
引用单个文件
解释一下@src/utils/auth.js中的逻辑
这包括对话中文件的完整内容。
引用目录
@src/components 的结构是什么?
这提供了包含文件信息的目录列表。
参考 MCP 资源
显示来自 @github:repos/owner/repo/issues 的数据
这使用 @server:resource 格式从连接的 MCP 服务器获取数据。有关详细信息,请参阅 MCP 资源。
温馨提示:
文件路径可以是相对路径或绝对路径
@文件引用将文件目录和父目录中的CLAUDE.md添加到上下文中
目录引用显示文件列表,而不是内容
您可以在一条消息中引用多个文件(例如,“@file1.js 和 @file2.js”)
使用扩展思维(思维模式)
默认情况下启用扩展思维,让克劳德有空间在做出回应之前一步一步推理复杂的问题。这种推理在详细模式下可见,您可以使用“Ctrl+O”打开该模式。此外,Opus 4.6 和 Sonnet 4.6 支持自适应推理:代替固定的思维令牌预算,