第8章:代码阅读与架构解释
一、学习目标
用 Codex 快速理解项目结构、调用链、数据流和风险点。
完成本章后,学员应能把相关概念转化为可执行的 Codex 任务,并能说明任务的边界、风险和验收方式。
二、本章适合谁学习
接手陌生项目的开发者、技术管理者。
三、核心概念讲解
Codex 在读码任务上的价值常被低估。相比直接改代码,先让它解释架构、生成调用链和指出复杂点,能降低后续修改风险。读码输出要避免泛泛总结,应该要求它引用文件路径、函数名、入口和实际调用关系。
在教学时,讲师应避免只展示“神奇结果”。更有效的方式是把任务输入、Codex 的中间判断、文件改动、验证命令和最终总结完整展示出来,让学员理解可复制的方法,而不是记住一次偶然成功的演示。
四、关键知识点
先问入口,再问核心模块。
让 Codex 输出文件级和流程级两种视角。
要求区分事实、推测和待验证点。
让它给出后续修改建议但暂不执行。
五、操作步骤或实践流程
明确任务目标:用一句话写清要解决的问题。
补充上下文:说明项目、目录、相关文件、技术栈和限制。
设定边界:说明哪些文件可以改、哪些不能改、哪些操作需要确认。
要求计划:复杂任务先让 Codex 给出步骤,不立即修改。
执行小步修改:每一步都保持可审阅。
运行验证:优先使用项目已有的 lint、test、build 或人工验收清单。
复盘输出:要求 Codex 总结改动、风险和后续建议。
六、典型案例
一个订单状态问题牵涉 API、状态机和定时任务。先生成数据流图,再改逻辑,比直接搜索关键字更稳。
推荐示例提示词:
请先阅读当前项目中与本任务相关的文件,输出你的理解、可能影响范围和建议修改计划。暂时不要修改文件。确认计划后,再按最小改动实现,并运行可用的验证命令。最后请总结修改内容、验证结果和剩余风险。
本章实践任务:让 Codex 分析一个接口从路由到数据库的完整链路。
七、常见错误与避坑指南
接受没有文件引用的架构解释。
把推测当事实。
读完不沉淀文档。
避坑原则:凡是会影响生产数据、权限、支付、认证、数据库迁移、凭证、批量删除或外部服务调用的任务,都应提高审批级别,并要求 Codex 先解释风险。
八、课堂练习
要求 Codex 输出“登录流程调用链表”。
练习交付物应包括:任务提示词、Codex 输出摘要、人工审阅意见、验证结果和复盘结论。
九、课后作业
生成一份项目架构速览文档,并人工校对关键路径。
作业提交格式建议:
### 任务背景 ### Codex 提示词 ### Codex 执行过程摘要 ### 修改或输出结果 ### 验证证据 ### 人工复盘
十、商业化交付建议
十一、本章小结
本章的关键不是记住单个命令,而是形成“目标明确、上下文充分、边界清楚、过程可审阅、结果可验证”的 Codex 协作方式。只要这个框架稳定,后续无论使用 CLI、IDE、云端任务还是团队流程,都能保持较高质量。
十二、参考资料
OpenAI Codex 官方文档首页
Codex Prompting Guide
openai/codex
OpenAI launches Codex coding agent
