AI 编程新手教程(1):用 Codex 读懂一个现成项目
大家好呀,我是 Lazy熊。我用的 API 配置好 Codex 之后,就能开始ai编程了。(结尾有全套教程)但如果你是 AI 编程新手,我不建议你第一天就直接让 Codex 写功能。这篇不讲安装,也不讲复杂配置。我只讲很对新手来说,第一天更重要的不是让它“写出多少代码”,
大家好呀,我是 Lazy熊。
我用LetAiCode 的 API 配置好 Codex 之后,就能开始ai编程了。(结尾有全套教程)
但如果你是 AI 编程新手,我不建议你第一天就直接让 Codex 写功能。
更稳的做法是:
先用 Codex 读懂一个现成项目。
这篇不讲安装,也不讲复杂配置。
我只讲 怎么用 Codex 快速看懂一个现成项目。
很对新手来说,第一天更重要的不是让它“写出多少代码”,
而是先搞清楚:
- 这个项目是做什么的
- 从哪里启动
- 入口文件在哪里
- 主要目录分别负责什么
- 如果以后要改功能,应该先看哪些文件
说白了就是一句话:
先让 Codex 帮你建立项目地图。
一、先说结论:第一天不要急着改代码,先完成 5 件事
如果你是第一天用 Codex 接触一个现成项目,我建议先完成这 5 件事:
- 让 Codex 先读项目目录
- 找出入口文件和启动命令
- 让它解释主要目录分别负责什么
- 选一个页面或功能,让它追一遍调用链
- 让它输出一份新手入门笔记
这 5 件事做完,你不一定能完全看懂项目。
但你至少会知道:
这个项目大概怎么跑、从哪里看、以后改功能该从哪里下手。
这对新手来说已经非常重要。
因为很多人不是不会让 Codex 写代码,
而是它写完之后,你根本不知道它改在哪里、为什么这么改、有没有影响别的地方。
所以第一天先别急着让它写。
先让它带你读项目。
二、第一步:先进入项目目录
这一步很基础,但特别关键。
你要让 Codex 读哪个项目,就先进入哪个项目目录。
比如:
不要在桌面、下载目录、用户根目录里直接启动。
因为 Codex 需要基于当前目录判断:
- 当前项目有哪些文件
- 配置文件在哪里
- 依赖和脚本在哪里
- 哪些目录像页面
- 哪些目录像组件
- 哪些目录像接口或服务
如果你目录进错了,后面它的判断就会跟着错。
所以第一天先记住:
先进入项目,再启动 Codex。
如果你手上没有现成项目,可以随便找一个你之前写过的小项目。
项目不用大。
最好是你能跑起来,但又没有完全看懂的那种。
因为这类项目最适合练“让 Codex 帮你读懂代码”。
三、第二步:第一条 Prompt,先让它只读不改
启动 Codex 后,第一句话不要写:
也不要写:
第一天更稳的写法是:
请先阅读当前项目,不要修改任何代码。
请告诉我:
1. 这个项目大致是做什么的
2. 你是根据哪些文件判断出来的
3. 主要目录分别负责什么
4. 入口文件可能在哪里
5. 启动、开发、构建命令分别是什么
这条 Prompt 的重点是:
不要修改任何代码。
新手第一天最怕的不是 Codex 不会写。
而是它一上来就动了文件,你还没看懂它为什么动。
所以先让它做一件低风险的事:
解释项目。
你可以把这一步理解成:
先让 Codex 当导游,
带你逛一圈项目。
四、第三步:让它输出一张“项目地图”
第一轮读完后,继续让它整理项目地图。
可以这样说:
请把这个项目整理成一份新手能看懂的项目地图。
请按下面格式输出:
1. 项目用途:一句话说明这个项目是做什么的
2. 技术栈:列出你判断出的主要技术栈
3. 启动命令:告诉我本地开发应该运行什么
4. 入口文件:列出最关键的入口文件
5. 主要目录:用表格说明每个目录负责什么
6. 新手阅读顺序:建议我先看哪 5 个文件
这一步特别适合新手。
因为很多项目刚打开时,文件很多。
你自己看,会觉得一团乱。
但让 Codex 先整理成地图,你会清楚很多:
- 哪些目录重要
- 哪些文件先看
- 哪些文件暂时不用管
- 项目大概是前端、后端,还是全栈
这里有个细节。
你不要只让它“总结一下”。
最好明确让它按结构输出。
因为结构越清楚,你后面越好复用。
五、第四步:让它找启动命令和验证方式
新手读项目时,最容易忽略一个问题:
项目到底怎么跑起来。
所以你要专门问一遍。
比如:
请专门帮我确认这个项目的启动方式。
请告诉我:
1. 依赖安装命令是什么
2. 本地开发启动命令是什么
3. 构建命令是什么
4. 测试或 lint 命令是什么
5. 这些命令是从哪些配置文件里判断出来的
为什么要问最后一句?
因为你不能只看 Codex 给出的结论。
你还要知道它是根据什么判断的。
比如它说启动命令是:
那你最好让它指出:
它是从 package.json 的哪一段看出来的。
这样你不是在盲信 Codex,
而是在学会让它帮你读配置。
六、第五步:选一个页面,让它追一遍调用链
只看项目地图还不够。
第一天最好再选一个具体页面或功能,让 Codex 带你顺一遍。
比如你看到项目里有一个列表页,
可以这样问:
请帮我追踪当前项目里的列表页逻辑。
请先不要修改代码。
请告诉我:
1. 列表页对应的文件在哪里
2. 这个页面用到了哪些组件
3. 数据是从哪里来的
4. 状态是在哪里管理的
5. 用户操作后,数据流大概怎么走
6. 如果我要给这个列表加搜索功能,最可能改哪些文件
这一步的价值很大。
因为你会第一次看到:
一个真实功能是怎么从页面、组件、数据、状态串起来的。
很多新手看项目看不懂,不是因为每一行代码都难。
而是看不懂文件之间怎么连。
Codex 很适合帮你做这件事:
把散落的文件串成一条线。
七、第六步:让它用新手能懂的话解释关键文件
找到关键文件后,不要急着让它改。
先让它解释。
比如:
请用新手能听懂的话解释这个文件。
请按下面格式说明:
1. 这个文件主要负责什么
2. 里面最重要的函数或组件是什么
3. 数据从哪里进来
4. 用户操作会触发哪些逻辑
5. 如果以后要改这个文件,最需要小心什么
这比你直接问:
要稳很多。
因为你规定了输出结构。
Codex 就不会只给你一段很泛的总结。
而是会按你需要的方式,把关键点讲清楚。
对新手来说,读代码不是要立刻看懂所有细节。
而是先知道:
- 这个文件干什么
- 哪些地方重要
- 哪些地方暂时不用碰
- 以后改功能要注意哪里
这就够了。
八、第七步:让 Codex 生成一份“第一天学习笔记”
读完项目后,我建议你最后让 Codex 输出一份学习笔记。
可以这样说:
请根据刚才对项目的阅读,帮我整理一份新手第一天学习笔记。
请包括:
1. 这个项目一句话介绍
2. 技术栈总结
3. 本地启动方式
4. 最重要的 5 个文件
5. 最重要的 3 条代码链路
6. 我下一步最适合练习的 3 个小任务
7. 暂时不建议我碰的高风险区域
这一步很实用。
因为你第一天不可能把所有东西都记住。
让 Codex 帮你整理一份笔记,
后面你再回来接着学,就不会从零开始。
特别是最后两项:
- 下一步适合练什么
- 暂时不要碰哪里
对新手很重要。
因为新手不是不能动项目,
而是要知道:
先从低风险区域动手。
九、第一天不要做这 5 件事
如果你是 AI 编程新手,第一天用 Codex 读现成项目,我不建议你做下面这些事。
1. 不要一上来就全项目重构
你还没看懂项目,就让它重构,
很容易改完之后你完全接不住。
2. 不要一上来就让它修复杂 bug
复杂 bug 往往牵扯调用链、状态、接口、环境。
第一天更适合先读懂一条正常链路。
3. 不要让它一次解释所有文件
项目稍微大一点,一次解释所有文件会非常乱。
更稳的方式是:
先目录,再入口,再具体功能。
4. 不要只看它的结论
它说入口文件在哪里,你要让它告诉你根据什么判断。
它说启动命令是什么,你要让它指出配置来源。
这样你是在学习项目,不是在盲信答案。
5. 不要第一天就追求完全看懂
这一点特别重要。
新手第一天的目标不是完全掌握项目。
而是建立基本地图。
你只要知道从哪里启动、先看哪些文件、怎么顺一条功能链路,就已经够了。
十、给你一套可以直接复制的第一天 Prompt
如果你想省事,可以直接把下面这段复制给 Codex。
我是 AI 编程新手,今天是我第一次用 Codex 阅读这个现成项目。
请你先不要修改任何代码。
请按下面步骤帮我读项目:
1. 先判断这个项目大致是做什么的
2. 找出主要技术栈
3. 说明主要目录分别负责什么
4. 找出入口文件和关键配置文件
5. 找出本地启动、构建、测试或 lint 命令
6. 推荐我第一天最应该看的 5 个文件
7. 选择一个最典型的页面或功能,帮我追一遍调用链
8. 最后整理一份新手第一天学习笔记
输出要求:
1. 用新手能听懂的话解释
2. 不要只给结论,要说明你是根据哪些文件判断的
3. 不要修改代码
4. 如果信息不确定,请明确说不确定,不要猜
这条 Prompt 非常适合第一天用。
它不会让 Codex 直接动项目,
而是让它先当你的项目讲解员。
部署篇
Codex 装好了却还是报错?我把最常见的问题,整理成了一份排查清单。
prompt技巧
Codex-AI 编程篇
更多推荐
所有评论(0)