在你刚加入的代码库中使用 Claude Code
Source: Dev.to
Introduction
Claude 在你加入新代码库时可以成为有价值的助手。它可以解释代码的功能、追踪数据流向,并回答关于组件如何连接的问题。然而,如果在你还未了解现有约定之前就让 Claude 进行修改,它可能会引入违背团队隐式标准的代码。
Use Claude as a Reader
- 提出如下问题:
- “这个函数是做什么的?”
- “这些数据从哪里来?”
- “为什么会这样组织代码?”
这些查询让 Claude 充当解释者,而不修改代码,帮助你快速建立心智模型。
Get an Overview of the System
向 Claude 提供代码库的相关部分并询问:
“描述一下这个系统是如何组织的。主要模块有哪些,它们的职责是什么,如何相互通信?”
Claude 的回答可能并不完美,但它能为你提供一个起始模型,远比手动阅读每个文件要快得多。
Learn or Create Team Conventions
- 如果仓库已经包含
CLAUDE.md,请先阅读。 - 如果不存在,在第一周结束后创建一个。内容可包括:
- 文件结构
- 命名模式
- 错误处理方式
- 测试风格
记录这些约定有助于保持 Claude 的输出与现有代码保持一致。
Make a Simple, Isolated Change
- 确定一个小且独立的任务。
- 请 Claude 实现它。
- 提交前,将生成的代码与周围文件进行比较:
- 命名是否一致?
- 错误处理是否遵循相同模式?
如果风格不符,要求 Claude 重写更改,使其匹配特定的相邻文件或函数。
Sample Prompts for Exploration
- “这个代码库是如何处理身份验证的?展示相关代码。”
- “如果我要添加一个新的 API 端点,应该以哪个已有端点为模型?”
- “这个文件的作用是什么?有哪些代码依赖它?”
- “如果我更改这个函数的签名,会导致什么破坏?”
Further Resources
Agent Prompt Playbook 包含一套入职问题集,提供 Claude 在一天内而非一周内映射新代码库的提示。