概览
使用 Codex 梳理陌生代码库,解释不同模块和数据流,并在你动手修改前指出接下来值得阅读的文件。
适合场景
- 刚加入新仓库或新服务、正在熟悉环境的新工程师
- 任何想在修改功能前先理解其工作方式的人
解释我需要了解的系统部分
解释在代码库中,请求是如何流经 <name of the system area> 的。 包括: - 哪些模块分别负责什么 - 数据在何处被校验 - 在进行修改前需要注意的主要陷阱 最后告诉我接下来应该阅读哪些文件。
建议推理强度:中
简介
当你刚接触一个仓库,或被安排去处理一个不熟悉的功能时,Codex 可以在你开始修改代码前帮助你快速建立整体认知。目标不仅是获得一个高层概览,而是梳理请求流,理解各模块分别负责什么,并找出下一批值得阅读的文件。
如何使用
如果你刚接触一个项目,可以直接让 Codex 解释整个代码库:
如果你需要为现有代码库贡献一个新功能,可以让 Codex 解释某个具体的系统部分。你定义的范围越清晰,得到的解释就越具体:
- 向 Codex 提供你想理解的相关文件、目录或功能区域。
- 让它追踪请求流,并解释哪些模块负责业务逻辑、传输、持久化或 UI。
- 在你修改任何内容之前,询问校验、副作用或状态转换发生在什么地方。
- 最后询问你接下来应该阅读哪些文件,以及有哪些高风险点。
一个有用的入门说明应该给你留下一张具体的地图,而不只是一个文件名列表。到最后,Codex 应该已经解释清楚主要流程,标出风险较高的部分,并指出在你开始修改前接下来需要关注的文件或检查项。
接下来可以问的问题
当 Codex 给出第一轮说明后,继续追问,直到解释具体到让你有信心进行第一次修改为止。好的追问通常会迫使它指出其中的假设、隐藏依赖,以及修改后真正重要的检查项。
- 哪个模块真正负责业务逻辑,而哪些只负责传输层或 UI 层?
- 校验发生在哪里,那里又强制执行了哪些假设?
- 如果我修改这条流程,哪些相关文件或后台任务最容易被忽略?
- 编辑这部分之后,我应该运行哪些测试或检查?
