Skip to content

常见工作流

探索代码库、修复 bug、重构、测试和其他日常任务的分步指南。

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

本页涵盖:

提示配方

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

理解新代码库

快速获取代码库概览

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

  1. 导航到项目根目录

    bash
    cd /path/to/project
  2. 启动 Claude Code

    bash
    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 分享错误

    I'm seeing an error when I run npm test
  2. 请求修复建议

    suggest a few ways to fix the @ts-ignore in user.ts
  3. 应用修复

    update user.ts to add the null check you suggested

提示:

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

重构代码

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

  1. 识别需要重构的遗留代码

    find deprecated API usage in our codebase
  2. 获取重构建议

    suggest how to refactor utils.js to use modern JavaScript features
  3. 安全地应用更改

    refactor utils.js to use ES2024 features while maintaining the same behavior
  4. 验证重构

    run tests for the refactored code

提示:

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

处理测试

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

  1. 识别未测试的代码

    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 可以分析你的代码路径并建议针对错误条件、边界值和容易被忽视的意外输入的测试。


创建拉取请求

你可以直接让 Claude 创建拉取请求("create a pr for my changes"),或逐步引导 Claude:

  1. 总结你的更改

    summarize the changes I've made to the authentication module
  2. 生成拉取请求

    create a pr
  3. 审查和完善

    enhance the PR description with more context about the security improvements

当你使用 gh pr create 创建 PR 时,会话会自动链接到该 PR。要稍后返回,运行 claude --from-pr <number> 或将 PR URL 粘贴到 /resume 选择器搜索中。

提交前审查 Claude 生成的 PR,并让 Claude 标记潜在风险或注意事项。

处理文档

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

  1. 识别未文档化的代码

    find functions without proper JSDoc comments in the auth module
  2. 生成文档

    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 中(不要使用 cmd+v)
    3. 向 Claude 提供图片路径。例如,"Analyze this image: /path/to/your/image.png"
  2. 让 Claude 分析图片

    What does this image show?
    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. 从视觉内容获取代码建议

    Generate CSS to match this design mockup
    What HTML structure would recreate this component?

提示:

  • 当文本描述不清楚或麻烦时使用图片
  • 包含错误、UI 设计或图表的截图以获得更好的上下文
  • 你可以在对话中处理多张图片
  • 图片分析适用于图表、截图、模型等
  • 当 Claude 引用图片时(例如,[Image #1]),Cmd+Click(Mac)或 Ctrl+Click(Windows/Linux)链接在默认查看器中打开图片

引用文件和目录

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

  1. 引用单个文件

    Explain the logic in @src/utils/auth.js

    这会将文件的完整内容包含在对话中。

  2. 引用目录

    What's the structure of @src/components?

    这会提供带文件信息的目录列表。

  3. 引用 MCP 资源

    Show me the data from @github:repos/owner/repo/issues

    这使用 @server:resource 格式从连接的 MCP 服务器获取数据。详见 MCP 资源

提示:

  • 文件路径可以是相对或绝对的
  • @ 文件引用将文件目录和父目录中的 CLAUDE.md 添加到上下文
  • 目录引用显示文件列表,而非内容
  • 你可以在单条消息中引用多个文件(例如,"@file1.js and @file2.js")

定期运行 Claude

假设你想让 Claude 自动定期处理任务,如每天早上审查打开的 PR、每周审计依赖,或夜间检查 CI 失败。

根据你想让任务运行的位置选择调度选项:

选项运行位置最适合
例程Anthropic 管理的基础设施即使电脑关闭也应该运行的任务。除了调度外,还可以通过 API 调用或 GitHub 事件触发。在 claude.ai/code/routines 配置。
桌面定时任务你的机器,通过桌面应用需要直接访问本地文件、工具或未提交更改的任务。
GitHub Actions你的 CI 管道与仓库事件(如打开的 PR)绑定的任务,或应与工作流配置并存的 cron 调度。
/loop当前 CLI 会话会话打开时的快速轮询。开始新对话时任务停止;--resume--continue 恢复未过期的任务。

编写定时任务的提示时,明确说明成功的样子以及如何处理结果。任务自主运行,无法提出澄清问题。例如:"Review open PRs labeled needs-review, leave inline comments on any issues, and post a summary in the #eng-reviews Slack channel."


向 Claude 询问其能力

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

示例问题

can Claude Code create pull requests?
how does Claude Code handle permissions?
what skills are available?
how do I use MCP with Claude Code?
how do I configure Claude Code for Amazon Bedrock?
what are the limitations of Claude Code?

Claude 提供基于文档的答案。要获得实践演示,运行 /powerup 获取带动画演示的交互式课程,或参考上面的特定工作流部分。

提示:

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

恢复之前的对话

当任务跨越多个时间段时,从中断的地方继续,而不是重新解释上下文。Claude Code 在本地保存每个对话。

bash
claude --continue

这恢复当前目录中最近的会话;如果还没有,它打印 No conversation found to continue 并退出。使用 claude --resume 从列表中选择,或从运行中的会话使用 /resume。查看管理会话了解命名、分支和完整的选择器参考。

使用 worktree 运行并行会话

在一个终端中处理功能,同时 Claude 在另一个终端中修复 bug,编辑不会冲突。每个 worktree 是自己分支上的独立检出。

bash
claude --worktree feature-auth

在第二个终端中用不同名称运行相同命令以启动隔离的并行会话。查看 Worktrees 了解清理、.worktreeinclude 和非 git VCS 支持。要从一个屏幕而非单独终端监控并行会话,请参阅后台 Agent

编辑前先规划

对于你想在触及磁盘前审查的更改,切换到计划模式。Claude 读取文件并提出计划,但在你批准前不做编辑。

bash
claude --permission-mode plan

你也可以在会话中按 Shift+Tab 切换到计划模式。查看计划模式了解批准流程和在文本编辑器中编辑计划。

将研究委托给子 Agent

探索大型代码库会用文件读取填满你的上下文。委托探索,这样只有发现返回。

use a subagent to investigate how our auth system handles token refresh

子 Agent 在自己的上下文窗口中读取文件并报告摘要。查看子 Agent了解定义具有自己工具和提示的自定义 Agent。

将 Claude 管道传入脚本

非交互地运行 Claude 用于 CI、pre-commit hook 或批处理。Stdin 和 stdout 像任何 Unix 工具一样工作。

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

查看非交互模式了解输出格式、权限标志和扇出模式。

下一步

AI 落地咨询
艾维禾砺数字科技

企业 AI 落地全链路服务

Agent 开发工作流搭建Claude Code 集成
微信咨询
d187l8801b6124
访问官网 ivheli.com