Codex 提示词最佳实践

Codex 是面向软件开发的 AI 编程助手可以帮助你理解项目、修改代码、修复 Bug、编写测试、生成文档和做代码审查。想让 Codex 更稳定地完成任务关键不是写很长的提示词而是把“目标、上下文、约束、输出和验证方式”说清楚。提示词基本结构一个实用的 Codex 提示词通常包含 5 个部分要素说明示例任务目标你希望 Codex 做什么“实现用户登录接口”项目上下文技术栈、模块位置、已有实现“项目使用 FastAPI认证逻辑在src/auth/”约束条件不能破坏什么、必须遵守什么“保持现有 API 响应格式不变”输出要求需要代码、说明、测试还是文档“修改代码并补充单元测试”验证方式如何确认完成“运行pytest tests/auth”推荐模板请在 [文件或模块] 中实现 [功能/修复/重构]。 上下文 - 项目使用 [技术栈] - 相关代码在 [路径] - 可参考 [已有文件/函数] 要求 - 保持 [兼容性/接口格式/代码风格] - 处理 [边界情况] - 不要修改 [不相关模块] 完成后 - 添加或更新测试 - 运行 [验证命令] - 简要说明改动内容完整提示词示例请为用户登录功能添加限流保护。 上下文 - 后端使用 FastAPI - 登录接口在 src/api/auth.py - Redis 客户端封装在 src/cache/redis_client.py - 现有错误响应格式参考 src/api/users.py 要求 - 同一邮箱 5 分钟内最多尝试 5 次 - 超限返回 HTTP 429 - 不改变成功登录响应结构 - 保持现有日志风格 完成后 - 添加对应单元测试 - 运行 pytest tests/api/test_auth.py - 总结修改了哪些文件这个提示词比“给登录加限流”更好因为 Codex 不需要猜文件位置、业务规则和验收标准。复杂任务要先拆解如果任务涉及多模块、多文件或不确定方案不要一上来让 Codex 直接大改。先让它分析或制定计划。请先阅读项目结构给出实现“订单退款功能”的计划。 不要修改代码。 计划中请说明 - 需要修改哪些模块 - 数据库是否需要变更 - 需要补充哪些测试 - 有哪些风险点确认计划后再继续按上面的计划实现第一步添加退款状态字段和数据库迁移。 完成后只运行相关迁移测试。在 Codex 桌面应用中也可以使用/plan处理多步骤任务使用/review做代码审查使用/init生成项目说明文件可用命令会随环境和权限不同而变化。(learn.chatgpt.com)提供有效上下文Codex 可以读项目文件但你给的上下文越准确它越少走弯路。建议提供类型示例技术栈“React Vite TypeScript”文件路径“修改src/components/UserTable.tsx”参考实现“参考ProductTable的分页写法”业务规则“管理员可以删除普通用户只能查看”验收标准“测试通过页面不出现布局抖动”如果某些规范会长期重复使用例如代码风格、测试命令、依赖策略可以写入AGENTS.md。Codex 会在开始工作前读取这些项目指令并支持全局指令与项目指令叠加。(learn.chatgpt.com)Bug 修复提示词修 Bug 时最重要的是给完整信息。请分析并修复下面的测试失败。 触发命令 pytest tests/api/test_login.py 错误信息 AssertionError: expected 200, got 500 Traceback: [粘贴完整堆栈] 期望行为 邮箱和密码正确时返回 token。 实际行为 接口返回 500。 要求 - 先说明可能原因 - 再修改代码 - 不影响注册接口 - 修复后重新运行相关测试不要只说“登录坏了”。要说明你做了什么、看到什么、期望什么、相关错误在哪里。图片和文件也可以当上下文当任务和视觉效果、报表、文档有关时可以直接给 Codex 图片或文件。例如根据这张设计稿实现设置页。 要求 - 保持移动端适配 - 使用项目现有组件库 - 完成后运行前端测试处理文档、表格、PDF、演示文稿时要说明源数据、目标文件类型、结构和检查标准。Codex CLI 可以在工作目录中创建或编辑文件但通常需要让它报告输出路径和执行过的检查。(learn.chatgpt.com)迭代优化第一次结果不完美很正常。好的做法是基于结果继续给具体反馈。这个实现功能正确但查询逻辑太复杂。 请重构 service 层 - 保持 API 行为不变 - 拆出 validateFilters 函数 - 保留现有测试或者页面已经接近设计稿但表格在 375px 宽度下按钮换行不好看。 请只调整响应式布局不改业务逻辑。反馈越具体返工越少。常见错误写法不推荐推荐“优化代码”“优化queryOrders减少重复数据库查询并补充性能测试”“修一下这个报错”“运行npm test出现以下报错请分析原因并修复”“加个页面”“新增订单详情页路径/orders/:id参考用户详情页布局”“重构项目”“先分析src/services的重复逻辑给出重构计划不要修改代码”常用提示词模板功能开发请在 [模块路径] 添加 [功能名称]。 要求 - 输入[输入格式] - 输出[输出格式] - 权限[权限规则] - 边界情况[异常/空数据/重复请求] - 参考[类似功能路径] 完成后添加测试并运行 [命令]。代码审查请审查当前改动重点关注 - 是否有逻辑错误 - 是否破坏兼容性 - 是否缺少测试 - 是否存在安全风险 请按严重程度列出问题并标明文件位置。重构请重构 [文件/模块]。 目标 - 降低重复代码 - 保持外部行为不变 - 不引入新依赖 完成后运行现有测试并说明重构前后的差异。最佳实践总结先说结果再补背景。指定文件、模块、参考实现和验证命令。复杂任务先计划确认后分步执行。修 Bug 时提供完整错误、触发步骤和期望行为。长期规范放进AGENTS.md一次性要求写在当前提示词里。让 Codex 修改后运行测试并汇报改动范围。不确定时先让 Codex 分析不要直接大规模改代码。参考来源菜鸟教程的 Codex 提示词文章结构、OpenAI/ChatGPT Learn 的 Prompting、AGENTS.md、Slash commands、Work with files 与 Code generation 文档。(runoob.com) (learn.chatgpt.com) (learn.chatgpt.com) (learn.chatgpt.com) (learn.chatgpt.com) (learn.chatgpt.com)