IDE 里第一次解释当前文件
IDE 里第一次解释当前文件
Section titled “IDE 里第一次解释当前文件”IDE 扩展最适合的第一件事不是改代码,而是解释你正在看的代码。
前置教程:Codex IDE 扩展安装与登录
如果你还没有装好 IDE 扩展并完成登录,先完成前置教程。
依据来源:OpenAI Codex 官方手册中关于 IDE 扩展自动包含打开文件、选中代码上下文和命令面板能力的说明。
你会学到什么
Section titled “你会学到什么”完成本篇后,你会知道:
- 如何让 Codex 解释当前打开文件。
- 如何让 Codex 解释选中的代码。
- 如何要求 Codex 不修改文件。
- 如何追问到你真正能看懂。
- 如何判断它有没有胡说。
第 1 步:打开一个文件
Section titled “第 1 步:打开一个文件”在练习项目里打开一个你想理解的文件。
新手建议选择:
README.mdpackage.jsonsrc/App.vuesrc/App.tsxsrc/pages/index.vuesrc/main.ts
不要一开始就打开特别长、特别复杂的文件。
第 2 步:先让 Codex 解释当前文件
Section titled “第 2 步:先让 Codex 解释当前文件”在 Codex 面板输入:
请解释我当前打开的这个文件。
要求:1. 不要修改任何文件。2. 用中文说明这个文件的作用。3. 按“整体作用、关键结构、可能关联的文件、我应该重点看哪里”四部分回答。4. 如果你无法确定某个判断,请明确说“不确定”,不要猜。这段提示词的重点是:
- 明确只读。
- 明确中文。
- 明确回答结构。
- 明确不确定就说不确定。
第 3 步:看回答是否具体
Section titled “第 3 步:看回答是否具体”好的回答应该包含:
- 文件整体作用。
- 关键函数、组件或配置项。
- 它可能和哪些文件有关。
- 新手应该先看哪几行或哪几块。
不好的回答通常是:
- 全是空话。
- 没提文件里的真实名字。
- 没说依据。
- 一上来就建议重构。
如果回答太虚,继续追问:
请更具体一点。请引用当前文件中的函数名、变量名、组件名或配置项来解释。仍然不要修改任何文件。第 4 步:解释选中代码
Section titled “第 4 步:解释选中代码”在编辑器里选中一小段代码。
不要一次选 300 行。
第一次建议选:
- 一个函数。
- 一个组件。
- 一个配置对象。
- 一个事件处理函数。
- 一个接口请求方法。
然后问:
请解释我选中的这段代码。
要求:1. 不要修改文件。2. 说明它的输入是什么。3. 说明它的输出或副作用是什么。4. 说明它依赖了哪些变量、函数或外部模块。5. 说明它可能有哪些边界情况。6. 用新手能听懂的话回答。第 5 步:让 Codex 画出调用关系
Section titled “第 5 步:让 Codex 画出调用关系”如果你还是不懂,可以继续问:
请用文字画出这段代码的调用关系。格式如下:
入口 -> 调用的函数 -> 影响的状态或返回值 -> 页面上看到的结果
不要修改任何文件。这个追问很适合前端组件、后端接口和工具函数。
第 6 步:让 Codex 给学习建议
Section titled “第 6 步:让 Codex 给学习建议”最后可以问:
如果我是第一次看这个文件,请告诉我接下来应该看哪 3 个地方。每个地方说明为什么值得看。不要修改任何文件。这比让 Codex 一次性解释整个项目更容易吸收。
第 7 步:判断它有没有胡说
Section titled “第 7 步:判断它有没有胡说”你不需要完全相信 Codex。
检查 4 件事:
- 它提到的文件名是否真实存在。
- 它提到的函数名是否在文件里。
- 它说的输入输出是否和代码一致。
- 它有没有把“不确定”的内容说得像确定事实。
如果你怀疑它在猜,直接问:
请指出你刚才每个判断分别依据了当前文件的哪一段代码。如果没有依据,请标记为推测。不要修改文件。完成后,你应该能做到:
- 用 IDE 扩展解释当前文件。
- 用 IDE 扩展解释选中代码。
- 用追问让解释更具体。
- 识别过于笼统或疑似胡说的回答。
- 全程不修改文件。
下一篇看:IDE 里第一次做局部修改。