Skip to content
反馈文档问题

理解一个代码库

面对不熟悉的仓库,先让 Agent 建立一张可验证的结构地图,再决定是否修改。Farming 的 Files、Chat 与 Terminal 可以把解释和真实证据放在同一个工作区里。

从一个问题开始

不要只说“分析这个仓库”。给出你真正想理解的方向:

text
请解释这个项目从用户请求到后台 Session 创建的主路径。
先不要修改文件。列出关键入口、状态所有者、主要失败路径和对应测试,
并说明你实际读取了哪些文件。

范围越明确,Agent 越容易给出可核对的答案。

先看结构,再看细节

要求 Agent 分阶段工作:

  1. 阅读仓库入口、开发文档和相关测试。
  2. 给出模块关系和关键边界。
  3. 选择少量权威文件深入说明。
  4. 指出仍然不确定、需要运行验证的部分。

在 Chat 中折叠不重要的过程,保留关键文件和命令证据。

阅读 Agent 的结构化过程阅读 Agent 的结构化过程

用 Files 核对

打开 Agent 引用的文件,检查:

  • 路径是否正确;
  • 代码是否真的承担所描述的职责;
  • 文档和测试是否支持这个结论;
  • Agent 是否把历史实现当成当前行为。

如果一个结论只来自命名或注释,让 Agent 继续追踪调用方、状态来源或测试。

用 Terminal 验证

需要确认启动命令、测试范围或生成过程时,要求 Agent 运行最小的只读或验证命令。不要一开始就执行全仓库的大型构建。

形成可复用结果

好的代码库说明应回答:

  • 核心产品路径是什么;
  • 谁拥有权威状态;
  • 哪些边界负责 Provider 或平台差异;
  • 失败如何变得可见;
  • 哪些测试能证明当前理解。

如果这份理解会长期影响开发,应把耐久结论更新到权威文档,而不是只留在 Chat 历史中。

Farming 是一个开源、自托管的 AI Coding Agent 工作区。