游乐游手机版
首页/AI教程/文章详情

Codex提示词最佳实践从基础到高级完整教程与技巧

时间:2026-08-06 13:54
高质量的Codex提示词应包含任务描述、上下文、约束条件和期望结果。复杂任务需拆解为小步骤逐步执行,提供充分上下文和完整错误信息,利用图片输入提升效率。通过迭代优化、避免歧义、使用参考示例,可显著提升代码生成质量。

写好提示词,是让 Codex 真正理解你的想法、高效完成任务的核心。这就像跟一个顶级工程师沟通,你描述得越清楚,他交付得越干脆。下面这些经验,都是从实践中磨出来的,直接来看。

Codex 提示词最佳实践


提示词基本结构

一个高质量的提示词,通常包含几个核心要素,就像一份明确的需求文档。把这些要素说清楚,Codex 才能精准发力。

基本要素

要素说明示例
任务描述你想做什么"实现用户登录功能"
上下文相关背景信息"使用现有的 auth 模块"
约束条件限制和要求"必须兼容现有 API"
期望结果具体产出"返回 JWT token"

结构化提示词

完整提示词示例

# 任务描述
实现一个用户登录 API 端点

# 上下文
- 项目使用 FastAPI 框架
- 已有 auth 模块处理认证逻辑
- 数据库使用 PostgreSQL

# 约束条件
- 使用现有的 JWT 工具生成 token
- 密码使用 bcrypt 验证
- 需要添加请求日志

# 期望结果
- 路径:POST /api/auth/login
- 请求体:{"email": "...", "password": "..."}
- 成功响应:{"token": "...", "user": {...}}
- 失败响应:{"error": "..."}

任务拆解原则

遇到复杂任务,别一股脑全丢给 Codex。把大任务拆成小步骤,一步步来,才是高效之道。这就像写代码一样,模块化总是更清晰、更可控。

拆解原则

  • 每个步骤有明确目标
  • 步骤之间依赖关系清晰
  • 每步完成后验证结果
  • 遇到问题可以回退

拆解示例

任务拆解

# 大任务
"实现完整的用户认证系统"

# 拆解成小任务
步骤 1:"设计认证系统的数据结构,包括用户表和 token 表"
步骤 2:"实现用户注册功能,包括密码加密和验证"
步骤 3:"实现用户登录功能,生成 JWT token"
步骤 4:"实现 token 验证中间件"
步骤 5:"实现用户登出功能"
步骤 6:"编写认证系统的测试"
步骤 7:"更新 API 文档"

使用 /plan 模式可以帮助 Codex 自动拆解复杂任务。


提供上下文信息

“没有上下文,就没有理解”——这句话在跟 Codex 沟通时尤其适用。提供充分的背景信息,能让它更准确地把握项目状态,避免产生“天马行空”的代码。

关键上下文

类型说明何时提供
技术栈框架、语言、库版本首次任务或新模块
项目结构模块位置、命名规范涉及多文件修改
现有代码相关函数、类、模块需要兼容或扩展
约束条件兼容性、性能要求有特殊限制

上下文提供方式

提供上下文

# 直接描述
"项目使用 Django 4.2,数据库是 PostgreSQL 15"

# 引用现有代码
"参考 src/utils/validator.py 的验证逻辑"

# 指定文件
"修改 src/api/users.py,保持与其他 API 一致的风格"

# AGENTS.md 自动提供
创建 AGENTS.md 文件,Codex 会自动读取项目规范

错误信息处理

错误信息是定位问题的钥匙。把完整的错误信息交给 Codex,它能快速帮你找到病根,比你自己一点点排查快得多。

提供完整错误信息

错误处理

# 提供完整错误
"运行测试时出现错误:

AssertionError: Expected status 200 but got 500
at test_login.py:45
in test_successful_login
Full traceback:
...

分析原因并修复"


# 截图辅助
附加错误截图,Codex 可以直接查看

错误信息要素

  • 错误类型和消息
  • 完整堆栈跟踪
  • 触发条件(做了什么操作)
  • 期望结果 vs 实际结果

图片输入

一张图胜过千言万语。Codex 支持图片输入,对于视觉信息,比如错误截图、设计稿、架构图,直接扔给它,沟通效率直接拉满。

适用场景

场景说明
错误截图截图显示错误界面或日志
设计稿UI 设计稿转换为代码
架构图解释架构图并实现
数据图表分析图表数据

图片输入方式

使用图片

# CLI
codex -i screenshot.png
codex --image design.png "根据设计稿实现页面"

# App/IDE
直接粘贴或拖拽图片到对话区域

# 多张图片
codex -i img1.png -i img2.png "对比这两张设计稿的差异"

迭代优化

好代码是改出来的。别指望一次就得到完美结果。通过“提出需求-检查结果-反馈优化”的循环,一步步把代码打磨到理想状态。

迭代流程

  1. Codex 完成初步实现
  2. 检查结果,提出改进点
  3. Codex 根据反馈调整
  4. 验证改进效果
  5. 重复直到满意

迭代优化

# 初步实现
"实现用户列表 API,支持分页"

# 检查后提出改进
"添加排序功能,支持按创建时间排序"

# 继续优化
"添加搜索功能,支持按用户名搜索"

# 性能优化
"优化查询性能,添加索引"

避免歧义

明确的提示词,是减少误解和返工的不二法门。避免使用“那个”、“修复”、“更快”这类模糊的说法,把它们具体化、量化。

歧义示例

避免歧义

# 模糊的提示词(不好)
"修改那个函数"

# 明确的提示词(好)
"修改 src/utils/helper.py 中的 format_date 函数"

# 模糊的提示词(不好)
"让它更快"

# 明确的提示词(好)
"优化 query_users 函数,查询时间从 500ms 降低到 100ms 以内"

# 模糊的提示词(不好)
"加个功能"

# 明确的提示词(好)
"在用户 API 中添加批量删除功能,接收用户 ID 列表"

使用参考示例

给 Codex 一个参考,它就能还你一个风格一致的成果。无论是代码风格、文档规范,还是输出格式,一个清晰的示例比任何口头描述都管用。

提供参考

# 参考现有代码风格
"参考 src/api/products.py 的风格,实现用户 API"

# 参考文档
"按照 OpenAPI 规范文档 docs/api-spec.yaml 实现"

# 参考示例
"按照这个格式返回响应:
{
'success': true,
'data': {...},
'message': '...'
}"


常见提示词模板

功能开发模板

功能开发

在 [模块路径] 添加 [功能名称] 功能

要求:
- 使用 [技术/库]
- 兼容 [现有系统]
- 包含 [边界处理]
- 返回 [响应格式]

参考:[现有类似功能路径]

Bug 修复模板

Bug 修复

问题描述:[Bug 表现]

触发条件:[什么情况下出现]

错误信息:
[完整错误堆栈]

期望行为:[正确结果应该是什么]

请分析原因并修复,不要影响其他功能。

代码审查模板

代码审查

/review [范围] for [重点]

# 示例
/review src/auth/ for security issues
/review HEAD~5..HEAD for performance regressions

最佳实践总结

核心原则

  • 明确具体,避免模糊表述
  • 提供充分上下文
  • 复杂任务拆解执行
  • 迭代优化,逐步完善
  • 验证结果,确保正确

效率技巧

  • 使用 AGENTS.md 减少重复说明
  • 利用 Skills 封装常用提示词
  • 使用图片传递视觉信息
  • 提供错误信息时要完整

常见问题

Q: Codex 理解错了怎么办?

提供更明确的描述,补充上下文,或使用参考示例。

Q: 如何让 Codex 遵循项目规范?

创建 AGENTS.md 文件定义规范,Codex 会自动遵循。

Q: 复杂任务如何处理?

使用 /plan 模式制定计划,分步执行并验证。

Q: 图片输入有什么限制?

支持 PNG、JPG、WebP 格式,建议分辨率适中(不要太小或太大)。

来源:https://www.runoob.com/codex/codex-prompting.html
上一篇Codex安全与企业管理最佳实践 下一篇Codex工作流模式核心原理详解与实战应用完整指南
本站内容用于信息整理与展示,如有侵权或内容问题请及时联系处理。

相关推荐

补充同频道和同主题内容,方便继续浏览更多相关内容。

同类最新

继续查看同栏目最近更新的文章。

更多
CAD零基础入门教程:坐标输入、图层管理与基础绘图命令
AI教程 · 2026-09-01

CAD零基础入门教程:坐标输入、图层管理与基础绘图命令

本文面向CAD零基础学习者,系统讲解坐标输入、图层管理与基础绘图命令的核心用法。通过分步实操与常见问题排查,帮助新手建立精确绘图习惯,掌握规范出图的基础能力。

CAD从入门到项目交付:绘图、标注、图块与实战工作流
AI教程 · 2026-09-01

CAD从入门到项目交付:绘图、标注、图块与实战工作流

掌握CAD的核心在于建立“画得准、标得清、复用快、交付稳”的工作流。本文提供从环境设置、高频命令组合、标注规范、图块标准化到项目分阶段交付的完整路径,帮助初学者避免常见返工陷阱,独立完成可检查、可复用、可打印的工程图纸。

Claude Code 登录指南:个人、Teams 与企业账号区分与授权步骤
AI教程 · 2026-09-01

Claude Code 登录指南:个人、Teams 与企业账号区分与授权步骤

本文详细解析 Claude Code 登录前的账号类型区分方法,涵盖个人订阅、Teams 席位与企业 Enterprise 席位的授权路径差异。提供终端登录命令、环境变量排查及常见异常处理步骤,帮助用户快速完成正确授权并避免登录路径混淆。

Claude Code 文件修改前的权限模式配置与命令审批指南
AI教程 · 2026-09-01

Claude Code 文件修改前的权限模式配置与命令审批指南

本文详细介绍Claude Code在修改文件前的权限模式配置方法,包括defaultMode可选值、permissions allow与deny规则设置、多层级配置文件管理以及 status验证技巧,帮助开发者安全高效地使用AI编程助手。

Claude Code接入VS Code后先测扩展和终端命令
AI教程 · 2026-09-01

Claude Code接入VS Code后先测扩展和终端命令

在VS Code中接入Claude Code后,建议优先验证扩展面板与集成终端两条入口。本文提供标准检查顺序、关键命令与常见故障排查路径,帮助你快速确认环境就绪,避免后续开发受阻。