Codex 提示词使用教程|精准指令,让AI编程更高效、更可控
Codex 提示词使用教程|精准指令,让AI编程更高效、更可控
提示词是与 Codex 高效协作的核心桥梁,如同指挥工程师完成开发任务,清晰、具体、结构化的指令能大幅提升代码质量、减少返工与沟通成本。本文基于 OpenAI 官方 Codex Prompting 指南,整理6 大核心提示技巧 + 实战案例 + 通用模板,覆盖日常开发、Bug 调试、功能实现、代码优化全场景,帮助你快速写出高质量提示词,让 Codex 精准理解需求、输出符合预期的结果。
一、提示词核心原则:像分配任务给工程师一样描述
Codex 不是简单的问答工具,而是可协同开发的AI 工程师,描述任务时遵循目标明确、上下文完整、约束清晰、可验证四大原则,避免模糊、笼统的指令。
一份高质量提示词通常包含:
目标:要实现、修复、优化的具体内容
上下文:涉及文件、代码片段、报错信息、依赖库
约束:代码规范、技术栈、禁止行为、格式要求
验收标准:如何验证任务完成
二、6 大核心提示技巧(官方推荐 + 实战案例)
技巧 1:提供清晰的代码指针,缩小检索范围
Codex 虽能自动定位相关代码,但明确指定文件、标识符、代码片段可大幅提升效率与准确性,避免在大型项目中无效检索。
✅ 最佳实践:
使用
@文件路径精准关联文件提供可检索的标识符(函数名、变量名、组件名)
粘贴完整错误堆栈、关键代码片段
❌ 糟糕示例
修复表单提交的 Bug
✅ 优质示例
修复
@src/components/LoginForm.tsx中表单提交无响应的 Bug,涉及handleSubmit函数,报错信息:TypeError: Cannot read properties of undefined (submit),仅修复交互逻辑,不修改业务代码。✅ 补充案例(后端接口场景):
修复
@src/api/order.ts中订单创建接口返回异常的问题,涉及createOrder函数,请求参数为\{userId: number, goodsId: number, count: number\},报错信息:Error: 数据库插入失败,goodsId 字段不能为空,仅修复参数校验逻辑,不修改数据库操作语句。
技巧 2:包含验证步骤,让 Codex 自检成果
Codex 会在完成任务后按你提供的步骤验证结果,有效降低错误率,确保输出符合预期。验证步骤包括:复现方式、校验命令、测试方法、Lint 规则等。
✅ 实战案例
为
@src/utils/formatDate.ts编写日期格式化函数,支持YYYY-MM-DD格式,完成后执行npm run test formatDate验证单元测试通过,运行npm run lint确保代码符合规范。✅ 补充案例(后端工具函数场景):
为
@src/utils/encrypt.ts编写 AES 加密函数,支持密钥自定义,加密内容为字符串类型,完成后执行pnpm run test encrypt验证加密/解密一致性,运行pnpm run lint:fix自动修复代码格式问题,确保符合团队 Node.js 编码规范。
技巧 3:自定义工作方式,指定执行规则
你可以直接指定 Codex 的工作流程、工具使用、输出格式、命名规范,让其完全贴合你的开发习惯与团队规则。
可自定义的内容:
参考特定提交 / 版本实现
日志输出规则、命令执行方式
PR 提交信息模板、代码注释风格
禁用特定工具 / 可执行文件
✅ 实战案例
实现用户列表分页接口,参考
@src/api/userList.ts的结构实现,使用axios发起请求,输出代码添加 JSDoc 注释,PR 信息格式为feat(api): 实现用户列表分页接口,避免使用console.log调试。✅ 补充案例(前端组件开发场景):
开发商品卡片组件
@src/components/GoodsCard.tsx,参考@src/components/BaseCard.tsx的样式结构,使用 TailwindCSS 编写样式,组件 props 需添加 TypeScript 类型定义,输出代码包含组件注释,禁止使用 inline 样式,遵循团队组件命名规范(PascalCase)。
技巧 4:拆分大型任务,化整为零
复杂任务(如完整模块开发、架构重构)直接交给 Codex 易出现逻辑混乱、遗漏需求,拆分为小而聚焦的子任务,更易测试、 review 与迭代。你也可以让 Codex 主动帮你拆解任务。
✅ 实战案例(拆分任务)
帮我把「开发电商商品详情页」拆分为子任务,按执行顺序列出:
梳理页面结构与依赖组件
实现页面基础布局与样式
开发商品信息展示模块
实现加入购物车 / 立即购买交互
添加响应式适配与异常处理
编写单元测试与校验
✅ 补充案例(后端模块拆分场景):
帮我把「开发用户权限管理模块」拆分为子任务,按执行顺序列出,贴合 Node.js + MongoDB 技术栈:
设计权限数据库表(user、role、user_role、permission),编写 SQL/MongoDB 脚本
实现角色创建、查询、修改、删除接口(CRUD)
开发用户角色分配与解绑接口
编写权限拦截中间件,实现接口权限控制
为所有接口添加参数校验与异常处理
编写单元测试与接口联调测试,生成接口文档
技巧 5:借力 Codex 高效调试,快速定位根因
遇到 Bug 或异常行为时,直接粘贴完整日志、错误堆栈、复现步骤,Codex 可并行分析问题,快速定位根因并给出修复方案,比手动排查更高效。
✅ 实战案例
分析以下报错日志,定位根因并给出最小改动修复方案,不重构无关代码:
TypeError: Cannot read properties of null (reading 'addEventListener')
at HTMLButtonElement.init (@src/js/button.js:25:15)复现步骤:打开页面→点击按钮→控制台报错,按钮点击事件失效。
✅ 补充案例(后端调试场景):
分析以下后端报错日志,定位根因并给出最小改动修复方案,不重构无关代码,贴合 Node.js + Express 技术栈:
Error: Cannot find module 'dotenv'
at Function.Module._resolveFilename (internal/modules/cjs/loader.js:902:15)
at Function.Module._load (internal/modules/cjs/loader.js:746:27)
at Module.require (internal/modules/cjs/loader.js:974:19)
at require (internal/modules/cjs/helpers.js:101:18)
at Object.<anonymous> (@src/config/index.js:3:16)复现步骤:启动后端服务(npm run dev)→ 控制台直接报错,服务启动失败,未修改过依赖相关配置。
技巧 6:善用开放式提示,挖掘额外价值
除定向任务外,开放式提示能让 Codex 发挥创造力,完成代码清理、漏洞扫描、方案脑暴、文档编写等拓展任务,带来意外效率提升。
✅ 实战案例
帮我清理
@src/components/Modal.tsx的冗余代码,优化性能,标注可删除的无效逻辑,同时生成一份组件使用说明文档。✅ 补充案例(后端开放式提示场景):
帮我分析
@src/service/orderService.ts的代码,找出潜在性能瓶颈(如重复数据库查询、冗余逻辑),给出优化建议并标注可修改的代码行,同时生成一份服务层代码使用规范文档,明确函数调用方式与参数要求。
三、通用提示词模板(直接复制套用)
1. Bug 修复模板
目标:修复【问题描述】
上下文:@文件路径 关键函数/变量:【名称】 报错信息:【完整报错】
约束:【代码规范、禁止行为、技术栈】
验证步骤:【复现方式、校验命令、测试方法】
验收标准:【问题不再复现、测试通过、无报错】2. 功能开发模板
目标:实现【功能名称】
上下文:@参考文件路径 依赖库:【库名】
约束:【代码规范、输出格式、命名规则】
执行要求:【工作流程、工具使用、注释规范】
验证步骤:【测试命令、校验规则】
验收标准:【功能正常、测试通过、符合规范】3. 代码优化模板
目标:优化【文件/模块】的【性能/可读性/冗余】
上下文:@文件路径
约束:【不修改业务逻辑、保留原有功能、规范要求】
优化方向:【具体优化点】
验证步骤:【校验命令、回归测试】
验收标准:【优化效果、无功能回归】四、常见提示误区与避坑
指令模糊:避免使用「优化代码」「修复 Bug」等笼统描述,务必具体
信息缺失:不提供文件路径、报错信息,导致 Codex 无效检索
任务过大:不拆分复杂任务,导致输出不完整、逻辑混乱
无验收标准:不告知验证方式,无法确保结果符合预期
过度约束:冗余规则过多,反而限制 Codex 发挥
✅ 误区实战案例(新手常踩坑):
❌ 错误提示(同时踩中“指令模糊+信息缺失”):优化接口性能
✅ 修正提示:优化@src/api/goodsList.ts中商品列表查询接口的性能,当前接口响应时间超过500ms,上下文:依赖 MongoDB 数据库,查询条件包含商品分类筛选,约束:不修改数据库结构,优化方向为添加查询索引、减少冗余字段返回,验证步骤:执行接口测试,确保响应时间≤300ms,无功能回归。
五、总结
Codex 提示词的核心是把 AI 当作协同工程师,用工程化的方式描述任务。通过「清晰代码指针 + 验证步骤 + 自定义规则 + 拆分任务 + 调试利用 + 开放式提示」六大技巧,配合结构化模板,能让 Codex 精准执行开发、调试、优化任务,大幅提升编程效率。
