先说结论:Codex 读陌生代码库有一套高效流程——先让它画目录结构地图,再逐模块讲解,最后问你关心的具体调用链。写文档也一样,先让它读透再写,你负责核事实和补示例。直接问”这项目干嘛的”效果很差,得分步来。
读代码工作流:三步从陌生到看懂
第一步:画结构地图。 让 Codex 扫一遍项目目录,输出顶层结构、各目录职责、入口文件、配置文件位置。这一步不要求细节,只要全景。
第二步:逐模块讲解。 拿着地图,挑你最关心的模块让它深入讲——这个模块做什么、对外暴露哪些接口、依赖哪些其他模块、数据怎么流转。一次问一个模块,别贪多。
第三步:追具体调用链。 当你对某个功能有疑问时,让它从入口到出口画出完整调用链。比如”用户点击提交按钮后,数据经过哪些函数、最终写到哪里”。这一步最能帮你理解项目的实际运行逻辑。
三步走完,你对项目的理解比通读代码快得多。关键是每一步都让 Codex 在回答前先读文件,不要让它凭上下文猜。
读代码提示词模板
请先不要修改任何文件。阅读当前项目并按以下顺序输出:
1. 顶层目录结构和每个目录的职责(一句话)
2. 项目入口文件和启动命令
3. 核心数据流:从用户输入到最终输出经过哪些模块
4. 依赖关系:哪些模块互相调用
5. 新手上手这个项目最容易踩的坑
输出格式用短段加列表,不要写长文。
写文档工作流:先读后写、人工核验
第一步:让 Codex 先读透。 用上面的读代码流程走一遍,确保它已经理解了项目结构和核心逻辑。不理解就写,出来的文档全是废话。
第二步:让它写初稿。 给出文档类型和目标读者。比如”给一个刚入职的前端写一份 README,包含项目简介、本地启动步骤、目录结构说明、开发约定和常见问题”。
第三步:你核事实。 Codex 写的文档里,命令是不是真的能跑、版本号对不对、配置路径有没有写错——这些必须你自己验证。它可能根据代码推断出一个合理但不正确的启动命令。
第四步:补使用示例。 Codex 擅长写结构,但真实的使用示例(比如一个实际的 API 调用、一段配置片段)你来补更靠谱,因为你知道团队实际怎么用。
写文档提示词模板
你已经阅读了当前项目。请为 [目标读者] 写一份 README 文档,包含:
1. 项目一句话简介
2. 本地开发环境要求和启动步骤(可复制的命令)
3. 目录结构说明(只列关键目录)
4. 开发约定(分支策略、提交规范、代码风格)
5. 常见问题和排查方式
注意:不确定的命令或配置,标注"请核实"而不是编造。
新手常犯的错误
直接问”这项目干嘛的”。 太笼统。Codex 会给你一段正确但没用的概括。分步问效果好十倍。
不让它读文件就问。 Codex 的回答质量取决于它实际读了多少代码。如果你只是口头描述项目,它只能根据你的描述推测,和真正读代码差距很大。在 Codex App 里确保它在项目目录中工作,在 CLI 里确保当前路径是项目根目录。
写完文档不验证命令。 README 里写的 npm run dev 到底能不能跑、端口是不是 3000——这种细节 Codex 可能从 package.json 推断出来但不保证准确,你跑一遍才知道。
配合 AGENTS.md 效果更好
如果项目里已经有 AGENTS.md,Codex 会自动读取其中的项目背景、命令、约定等信息,读代码和写文档的质量都会更高。还没有 AGENTS.md 的项目,可以让 Codex 用 /init 生成一份初稿。
关于 AGENTS.md 怎么写才有效,参考站内 AGENTS.md 写法指南。Codex App 的基本操作和线程管理,参考 Codex App 使用教程。
套餐、价格、模型以 OpenAI 官网当时显示为准,本文核对日期 2026-09-17。