Codex use case
理解大型代码库
追踪请求流程,梳理陌生模块,快速找到相关文件。
Difficulty 简单
Time horizon 5 分钟
使用 Codex 梳理陌生代码库、讲解不同模块和数据流,并在您修改代码前指出接下来值得阅读的文件。
最适合
- 需要熟悉新代码仓库或服务的新工程师
- 希望在修改某项功能前了解其工作原理的任何人
Contents
理解大型代码库
追踪请求流程,梳理陌生模块,快速找到相关文件。
使用 Codex 梳理陌生代码库、讲解不同模块和数据流,并在您修改代码前指出接下来值得阅读的文件。
简单
5 分钟
最适合
- 需要熟悉新代码仓库或服务的新工程师
- 希望在修改某项功能前了解其工作原理的任何人
入门提示
请解释请求如何流经代码库中的 <name of the system area>。
请包括:
- 各个模块分别负责什么
- 数据在哪里进行验证
- 进行修改前最需要注意的陷阱
最后列出我接下来应该阅读的文件。
请解释请求如何流经代码库中的 <name of the system area>。
请包括:
- 各个模块分别负责什么
- 数据在哪里进行验证
- 进行修改前最需要注意的陷阱
最后列出我接下来应该阅读的文件。
简介
当您初次接触某个代码仓库,或突然需要处理一项陌生功能时,Codex 可以帮助您在开始修改代码前理清情况。目标不只是获得一份概要说明,还要梳理请求流程、了解各模块的职责,并找出接下来值得阅读的文件。
使用方法
如果您刚接触一个项目,可以先直接请 Codex 讲解整个代码库:
请为我讲解这个代码仓库
如果您需要为现有代码库添加一项新功能,可以请 Codex 讲解相关的具体系统部分。您把请求范围界定得越清楚,得到的解释就越具体:
- 向 Codex 提供您想了解的相关文件、目录或功能区域。
- 让 Codex 追踪请求流程,并说明业务逻辑、传输、持久化或 UI 分别由哪些模块负责。
- 在修改任何内容前,询问验证、副作用或状态转换发生在哪里。
- 最后,询问您接下来应该阅读哪些文件,以及哪些地方存在风险。
一份有用的入门解答应为您绘制出具体的代码脉络图,而不只是列出一串文件名。最终,Codex 应该解释清楚主要流程、指出风险点,并说明您在开始修改前还应该阅读哪些文件或进行哪些重要检查。
接下来可以提出的问题
Codex 给出初步解答后,请继续追问,直到解释足够具体,让您有把握进行第一次修改。好的后续问题通常能促使 Codex 明确指出各种前提假设、隐藏依赖项,以及修改后需要进行的重要检查。
- 哪个模块负责实际业务逻辑,而哪些模块负责传输层或 UI 层?
- 验证在哪里进行,那里会强制要求满足哪些前提条件?
- 如果我修改这个流程,哪些相关文件或后台作业容易被遗漏?
- 修改这个部分后,我应该运行哪些测试或检查?