AI 编程工具 · 第 1 篇
Codex 入门
Getting Started with Codex
【示例内容】这篇是占位笔记,用来演示笔记页的全部组件。正文结构和措辞都是示例,等写真实教程时直接替换。
读完这一篇,你应该能够:
- 说清楚 AI 编程助手和普通代码补全的区别
- 写出一条“目标 + 上下文 + 验收标准”的任务描述
- 知道改动落地前要检查哪几样东西
本篇目录(4 节)
它到底是什么
先用一句话说清楚:AI 编程助手是一个能读你的代码、按你的要求改代码、还能自己跑命令验证的智能体(agent)。
和普通的代码补全(code completion)不同,它面对的是整个任务,而不是光标后面那一行。
一句话记住
把它当成一位“刚入职、很勤快、但不了解背景”的同事:任务说得越清楚,结果越好。
打个比方
普通补全像输入法联想,只帮你把这句话说完;编程助手像请了一位实习生,你交代一件事,他自己去翻代码、动手改、跑测试,最后把改动交给你审。
所以关键不在“它会不会写代码”,而在你会不会交代任务。
怎么给它布置任务
一条好的任务描述通常有三部分:
公式任务描述模板
目标:<要达成什么,一句话>
上下文:<相关文件、约束、已有做法>
验收:<怎样算做完,比如哪个测试要通过>- 目标:只写一件事,避免“顺便也把……”
- 上下文:告诉它去看哪些文件、不能动哪些文件
- 验收:可执行、可检查,比如
npm test全部通过
算一遍把一句模糊的需求改写成好任务
原始需求:“帮我把登录做好一点。”
- 找出真正的目标:登录失败时要给出明确提示。
- 补上下文:登录逻辑在
src/auth/login.ts,不要改数据库结构。 - 写验收:新增一个测试,密码错误时返回“密码不正确”。
- 合起来:“在
src/auth/login.ts里,密码错误时返回‘密码不正确’提示;不改数据库;新增对应单元测试并通过。”
答:改写后的任务有明确目标、范围和验收标准,助手不用猜。
先想一想
下面哪条任务描述最好?
- A. “优化一下代码。”
- B. “把
utils.js里的日期格式化函数改成支持时区,并补测试,npm test通过即可。” - C. “把整个项目重构成 TypeScript。”
想好了,看答案
选 B。A 没有目标,助手只能乱猜;C 范围太大,一次很难验收。B 有明确的文件、目标和验收标准。
检查它的改动
助手交回改动以后,不要直接合并。
实操要点
- 先看 diff:改了哪些文件,有没有动到不该动的地方。
- 再看 测试:它说测试通过了,自己再跑一遍。
- 最后看 说明:让它用三句话解释改了什么、为什么这么改。
别踩坑
- 一次给它十件事,最后一起验收。
- 只看它的总结,不看实际 diff。
- 测试失败时让它“直接把测试删了”。
- 一次一件事,每件事都有能执行的验收标准。
本篇小结
- 编程助手面对的是任务,不是一行代码。
- 好任务 = 目标 + 上下文 + 验收。
- 改动一定要自己看 diff、跑测试。