Claude Code 中文文档

常见工作流程

逐步指南:使用 Claude Code 探索代码库、修复 Bug、重构、测试及其他日常任务。

本页面收集了日常开发的简短步骤指南。有关提示和上下文管理的更高级指导,请参阅 最佳实践

本页面涵盖:

提示步骤指南

这些是用于日常任务的提示模式,例如探索不熟悉的代码、调试、重构、编写测试和创建 PR。每个模式都适用于任何 Claude Code 界面;请根据项目调整措辞。

了解新代码库

有关在 monorepo 或大型代码库中配置 Claude Code,请参阅 Monorepo 与大型仓库

快速概览代码库

假设你刚加入一个新项目,需要快速了解其结构。

  1. 进入项目根目录
    cd /path/to/project 

    /path/to/project 替换为你的项目路径。

  2. 启动 Claude Code
    claude 
  3. 请求高层次概览
    给我一个这个代码库的概述
    give me an overview of this codebase
  4. 深入探索特定组件
    解释这里使用的主要架构模式
    explain the main architecture patterns used here
    关键的数据模型是什么?
    what are the key data models?
    认证是如何处理的?
    how is authentication handled?
💡

提示:

  • 从宽泛的问题开始,然后缩小到特定区域
  • 询问项目中使用的编码规范和模式
  • 请求一份项目专属术语词汇表

查找相关代码

假设你需要定位与特定功能或特性相关的代码。

  1. 让 Claude 查找相关文件
    找出处理用户认证的文件
    find the files that handle user authentication
  2. 了解组件如何交互的上下文
    这些认证文件是如何协同工作的?
    how do these authentication files work together?
  3. 理解执行流程
    从前端到数据库追踪登录流程
    trace the login process from front-end to database
💡

提示:

  • 明确你要寻找的内容
  • 使用项目中的领域语言
  • 安装对应语言的 代码智能插件,为 Claude 提供精准的“转到定义”和“查找引用”导航

高效修复 Bug

假设你遇到了一个错误信息,需要找到其根源并修复。

  1. 向 Claude 分享错误信息
    运行 npm test 时我看到一个错误
    I'm seeing an error when I run npm test
  2. 请求修复建议
    建议几种修复 user.ts 中 @ts-ignore 的方法
    suggest a few ways to fix the @ts-ignore in user.ts
  3. 应用修复
    更新 user.ts 以添加你建议的 null 检查
    update user.ts to add the null check you suggested
💡

提示:

  • 告诉 Claude 复现问题的命令并获取堆栈跟踪信息
  • 提及复现错误的所有步骤
  • 让 Claude 知道错误是间歇性还是持续性的

重构代码

假设你需要更新旧代码,使其采用现代模式和实践。

  1. 识别需要重构的遗留代码
    在我们的代码库中找出已弃用的 API 用法
    find deprecated API usage in our codebase
  2. 获取重构建议
    建议如何重构 utils.js 以使用现代 JavaScript 特性
    suggest how to refactor utils.js to use modern JavaScript features
  3. 安全地应用更改
    重构 utils.js 以使用 ES2024 特性,同时保持相同的行为
    refactor utils.js to use ES2024 features while maintaining the same behavior
  4. 验证重构结果
    为重构后的代码运行测试
    run tests for the refactored code
💡

小贴士:

  • 让 Claude 解释现代方案的优势
  • 在需要时要求更改保持向后兼容性
  • 以小的、可测试的增量进行重构

编写测试

假设你需要为未覆盖的代码添加测试。

  1. 识别未测试的代码
    在 NotificationsService.swift 中找出未被测试覆盖的函数
    find functions in NotificationsService.swift that are not covered by tests
  2. 生成测试脚手架
    为通知服务添加测试
    add tests for the notification service
  3. 添加有意义的测试用例
    为通知服务中边界条件添加测试用例
    add test cases for edge conditions in the notification service
  4. 运行并验证测试
    运行新的测试并修复所有失败
    run the new tests and fix any failures

Claude 可以生成遵循项目现有模式和约定的测试。在请求测试时,请明确说明你希望验证哪些行为。Claude 会检查你现有的测试文件,以匹配已经使用的风格、框架和断言模式。

为了获得全面的覆盖率,可以让 Claude 找出你可能遗漏的边界情况。Claude 能够分析代码路径,并建议针对错误条件、边界值以及容易被忽略的异常输入编写测试。


创建 Pull Request

你可以直接让 Claude 为你创建 pull request(例如,"为我的更改创建一个 pr"),也可以按步骤引导 Claude 完成:

  1. 总结你的更改
    总结我对认证模块所做的更改
    summarize the changes I've made to the authentication module
  2. 生成 Pull Request
    创建一个 pr
    create a pr
  3. 审核并完善
    增强 PR 描述,提供更多关于安全改进的上下文
    enhance the PR description with more context about the security improvements

当你使用 gh pr create 创建 PR 时,会话会自动关联到该 PR。要稍后查找,可使用你的 PR 编号运行 claude --from-pr 1234,这样会打开会话选择器,并筛选出与该 PR 关联的会话;或者将 PR URL 粘贴到 /resume 选择器 的搜索框中。

💡

提交前先审查 Claude 生成的 PR,并让 Claude 高亮潜在的风险或需要考虑的事项。

处理文档

假设你需要为代码添加或更新文档。

  1. 识别缺少文档的代码
    在 auth 模块中查找没有适当 JSDoc 注释的函数
    find functions without proper JSDoc comments in the auth module
  2. 生成文档
    为 auth.js 中未文档化的函数添加 JSDoc 注释
    add JSDoc comments to the undocumented functions in auth.js
  3. 审核并增强
    改进生成的文档,提供更多上下文和示例
    improve the generated documentation with more context and examples
  4. 验证文档
    检查文档是否符合项目标准
    check if the documentation follows our project standards
💡

小贴士:

  • 指定你想要的文档风格(JSDoc、docstrings 等)
  • 要求在文档中加入示例
  • 为公共 API、接口和复杂逻辑请求文档

在笔记与非代码文件夹中工作

Claude Code 可在任何目录下运行。在笔记库、文档文件夹或任何 Markdown 文件集合中运行它,就能像处理代码一样搜索、编辑和重新组织内容。

.claude/ 目录和 CLAUDE.md 文件会与其他工具的配置目录共存,不会产生冲突。Claude 在每次工具调用时都会重新读取文件,因此下一次读取时就能看到你在其他应用中做出的编辑。

处理图片

假设你需要在代码库中处理图片,并希望 Claude 帮助你分析图片内容。

  1. 将图片添加到对话中

    你可以使用以下任意一种方法:

    1. 将图片拖放到 Claude Code 窗口中
    2. 复制一张图片,然后用 Ctrl+V 将其粘贴到 CLI 中。在 macOS 上,Cmd+V 在 iTerm2 中同样有效。
    3. 向 Claude 提供图片路径。例如:"Analyze this image: /path/to/your/image.png"
  2. 让 Claude 分析图片
    这张图片展示了什么?
    What does this image show?
    描述这张截图中的 UI 元素
    Describe the UI elements in this screenshot
    这个图表中有什么问题元素吗?
    Are there any problematic elements in this diagram?
  3. 使用图片提供上下文
    这是一张错误的截图。是什么导致了它?
    Here's a screenshot of the error. What's causing it?
    这是我们当前的数据库模式。我们应该如何为新的功能进行修改?
    This is our current database schema. How should we modify it for the new feature?
  4. 从视觉内容中获取代码建议
    生成匹配这个设计模型的 CSS
    Generate CSS to match this design mockup
    什么样的 HTML 结构会重新创建这个组件?
    What HTML structure would recreate this component?
💡

提示:

  • 当文字描述不清晰或不方便时,使用图片
  • 将错误截图、UI 设计稿或示意图包含进来,以便提供更好的上下文
  • 你可以在一次对话中处理多张图片
  • 图片分析功能适用于示意图、截图、原型图等
  • 当 Claude 引用图片时(例如 [Image #1]),在 Mac 上使用 Cmd+Click,在 Windows/Linux 上使用 Ctrl+Click 点击链接,即可在默认查看器中打开图片

引用文件和目录

使用 @ 可以快速包含文件或目录,无需等待 Claude 读取它们。

  1. 引用单个文件
    解释 @src/utils/auth.js 中的逻辑
    Explain the logic in @src/utils/auth.js

    这会将文件的完整内容纳入对话中。

  2. 引用目录
    @src/components 的结构是什么?
    What's the structure of @src/components?

    这会提供一个包含文件信息的目录列表。

  3. 引用 MCP 资源
    展示来自 @github:repos/owner/repo/issues 的数据
    Show me the data from @github:repos/owner/repo/issues

    这会使用 @server:resource 格式从已连接的 MCP 服务器获取数据。详情请参阅 MCP 资源

💡

提示:

  • 文件路径可以是相对路径或绝对路径
  • 输入 @ 可打开路径建议菜单,按 Enter 或 Tab 接受高亮路径,再次按 Enter 即可发送消息
  • @ 文件引用会将文件所在目录及其父目录中的 CLAUDE.md 添加到上下文中
  • 目录引用显示的是文件列表,而非文件内容
  • 你可以在一条消息中引用多个文件(例如 "@file1.js and @file2.js")

按计划运行 Claude

假设您希望 Claude 在定期自动执行任务,例如每天早上审查待处理的 PR、每周审计依赖项,或夜间检查 CI 故障。

根据您希望任务运行的位置选择调度方案:

选项 运行位置 最适合的场景
Routines Anthropic 托管的基础设施 需要在您的电脑关机时仍然运行的任务。除了按计划运行外,还可以通过 API 调用或 GitHub 事件触发。在 claude.ai/code/routines 中配置。
桌面计划任务 您本机,通过桌面应用运行 需要直接访问本地文件、工具或未提交更改的任务。
GitHub Actions 您的 CI 流水线 与仓库事件(如打开 PR)相关的任务,或者希望与工作流配置一同维护的 cron 计划。
/loop 当前 CLI 会话 在会话打开期间进行快速轮询。当您开始新对话时任务会停止;--resume--continue 可以恢复未过期的任务。
💡

为计划任务编写提示时,请明确说明成功的标准以及如何处理结果。任务是自主运行的,因此无法提出澄清性问题。例如:"审查标记为 needs-review 的待处理 PR,对任何问题留下内联评论,并在 #eng-reviews Slack 频道中发布摘要。"


询问 Claude 关于其能力的问题

Claude 内置了对其文档的访问能力,可以回答有关自身功能和限制的问题。

示例问题

Claude Code 可以创建拉取请求吗?
can Claude Code create pull requests?
Claude Code 如何处理权限?
how does Claude Code handle permissions?
有哪些技能可用?
what skills are available?
如何在 Claude Code 中使用 MCP?
how do I use MCP with Claude Code?
如何为 Amazon Bedrock 配置 Claude Code?
how do I configure Claude Code for Amazon Bedrock?
Claude Code 的限制是什么?
what are the limitations of Claude Code?
📝

Claude 对这些问题提供基于文档的回答。如需动手演示,请运行 /powerup 获取带有动画演示的交互式教程,或参考上面相应的特定工作流部分。

💡

提示:

  • 无论您使用哪个版本,Claude 始终可以访问最新的 Claude Code 文档
  • 提出具体问题以获得详细答案
  • Claude 可以解释复杂功能,如 MCP 集成、企业配置和高级工作流

恢复之前的对话

当一项任务需要跨越多个时段时,你可以从上次中断的地方继续,无需重新解释上下文。Claude Code 会在本地保存每一次对话。

claude --continue

这会恢复当前目录下最近的一次会话;如果还没有任何会话,它会打印 No conversation found to continue(未找到可继续的对话)并退出。使用 claude --resume 可以从列表中选择,或者在运行中的会话里使用 /resume。关于命名、分支以及完整的选择器参考,请参阅管理会话

使用 worktree 并行运行会话

在一个终端里开发功能,同时在另一个终端里让 Claude 修复 bug,二者的编辑不会相互冲突。每个 git worktree 都是基于已有提交创建、位于自己分支上的独立检出,因此仓库至少需要有一个提交。

claude --worktree feature-auth

在第二个终端中以不同的名称运行相同命令,即可启动一个隔离的并行会话。在没有提交的仓库中,该命令会失败并提示 Failed to resolve base branch "HEAD": git rev-parse failed(无法解析基础分支 "HEAD":git rev-parse 失败)。关于清理、.worktreeinclude 以及非 git 版本控制系统的支持,请参阅 Worktrees。如果想在一个屏幕上监控并行会话而非使用多个独立终端,请参阅后台智能体

先规划再编辑

如果你希望在改动落到磁盘之前先进行审查,可以切换到规划模式。Claude 会读取文件并提出修改计划,但在你批准之前不会进行任何编辑。规划模式激活时,状态栏会显示 ⏸ plan mode on(⏸ 规划模式已开启)。

claude --permission-mode plan

你也可以在会话期间按下 Shift+Tab 来循环切换到规划模式。循环顺序为 default(默认)→ acceptEdits(接受编辑)→ plan(规划)。关于批准流程以及在文本编辑器中编辑计划的内容,请参阅规划模式

将探索任务委托给子智能体

浏览大型代码库会占用大量上下文空间。将探索工作委托出去,你只需要接收最终的发现结果。

使用子代理调查我们的认证系统如何处理令牌刷新
use a subagent to investigate how our auth system handles token refresh

子智能体会在自己的上下文窗口中读取文件,并汇报一份摘要。关于定义拥有自定义工具和提示词的智能体,请参阅子智能体

将 Claude 管道化用于脚本

在 CI、预提交钩子或批处理等场景中,以非交互方式运行 Claude。其标准输入和标准输出的使用方式与任何 Unix 工具一样。

git log --oneline -20 | claude -p "summarize these recent commits"

关于输出格式、权限标志以及扇出模式,请参阅非交互模式

接下来的步骤

本页为 官方英文文档 的中文译版(机器翻译 + 结构校验)· 译于 2026-07-17 · 以英文原文为准 · 返回 Claude Code 提示词库