Codex 用例
理解大型代码库
追踪请求流,梳理陌生模块,并快速找到正确的文件。
难度 简单
时间周期 5m
使用 Codex 梳理陌生的代码库,解释不同的模块和数据流,并在你修改之前指出接下来值得阅读的文件。
适用场景
- 刚入职并接触新代码库或服务的新工程师
- 任何试图在修改功能前了解其工作原理的人
目录
理解大型代码库
追踪请求流,梳理陌生模块,并快速找到正确的文件。
使用 Codex 梳理陌生的代码库,解释不同的模块和数据流,并在你修改之前指出接下来值得阅读的文件。
简单
5m
适用场景
- 刚入职并接触新代码库或服务的新工程师
- 任何试图在修改功能前了解其工作原理的人
起始提示词
解释代码库中请求是如何流经 <系统区域名称> 的。包括:- 哪些模块负责哪些功能 - 数据在哪里进行验证 - 在进行修改之前需要注意的主要陷阱 最后列出接下来我应该阅读的文件。
解释代码库中请求是如何流经 <系统区域名称> 的。包括:- 哪些模块负责哪些功能 - 数据在哪里进行验证 - 在进行修改之前需要注意的主要陷阱 最后列出接下来我应该阅读的文件。
简介
当你刚接触一个代码库,或者接手了一个陌生的功能时,Codex 可以在你开始修改代码之前帮助你理清头绪。其目的不仅是获得一个高层次的总结,而是要梳理出请求流、理解各个模块的职责,并找出接下来值得阅读的文件。
如何使用
如果你刚接触一个项目,可以直接让 Codex 解释整个代码库:
为我解释一下这个代码库
如果你需要向现有的代码库中添加新功能,可以让 Codex 解释特定的系统区域。你设定的请求范围越精确,得到的解释就越具体:
- 向 Codex 提供你想要了解的相关文件、目录或功能区域。
- 让它追踪请求流,并解释哪些模块负责业务逻辑、传输、持久化或 UI。
- 在修改任何内容之前,先询问验证、副作用或状态转换发生在哪里。
- 最后问它接下来应该阅读哪些文件,以及哪些地方存在风险。
一个实用的引导解答应该为你提供一个具体的图谱,而不仅仅是文件名列表。最终,Codex 应该解释清楚主流程,指出高风险部分,并提示你在开始修改前需要关注的下一步文件或检查项。
接下来可以问的问题
一旦 Codex 给出了初步解答,请继续追问,直到解释足够具体,让你有信心进行首次修改。好的后续问题通常会促使它指出潜在的假设、隐藏的依赖关系,以及修改后需要执行的重要检查。
- 哪个模块负责实际的业务逻辑,哪个负责传输或 UI 层?
- 验证在哪里进行,并在那里执行了哪些假设条件?
- 如果我修改了这个流程,哪些相关文件或后台任务容易被忽略?
- 修改此区域后,我应该运行哪些测试或检查?