Codex示例提示:实际可用的AI编程任务模板

【免费下载链接】codex 为开发者打造的聊天驱动开发工具,能运行代码、操作文件并迭代。 【免费下载链接】codex 项目地址: https://gitcode.com/GitHub_Trending/codex31/codex

在日常开发中,你是否经常遇到这样的问题:如何向AI清晰描述编程需求?如何确保AI生成的代码符合项目规范?如何让AI理解复杂的业务逻辑并给出可执行的解决方案?本文将通过Codex项目的官方提示模板,帮助你掌握编写有效AI编程任务提示的核心方法,让AI真正成为你的开发助手。

提示模板的核心结构

Codex作为聊天驱动的开发工具,其提示设计遵循"目标-约束-步骤"的黄金三角结构。官方核心提示文件codex-rs/core/prompt.md中定义了AI代理的行为准则,强调任务描述需要包含明确的预期结果、执行边界和验证标准。

基础模板框架

# 任务目标
[清晰描述需要完成的功能或修复的问题]

# 技术约束
- 编程语言/框架: [如Rust 1.75+, TypeScript 5.2]
- 文件路径限制: [如仅修改src/cli/目录下文件]
- 风格要求: [如遵循项目AGENTS.md规范]

# 验收标准
- [功能点1验证方法]
- [性能/安全指标]
- [兼容性要求]

这种结构化设计能显著提升AI理解任务的准确率,特别是在处理复杂项目时。Codex的GPT-5专用提示codex-rs/core/gpt_5_codex_prompt.md进一步强化了工具调用规范,要求明确指定工作目录和权限级别。

实战模板示例

1. 文件编辑任务模板

当需要AI修改特定文件时,应明确指出文件路径、修改范围和测试要求。以下是一个符合Codex规范的示例:

# 任务目标
在CLI登录功能中添加密码强度验证

# 技术约束
- 文件路径: src/login/src/lib.rs
- 依赖: 使用现有password-validator crate
- 错误处理: 符合项目[error.rs](https://link.gitcode.com/i/ed178e8012cc91de49d7428ecc56f453)定义的错误类型

# 修改要点
1. 在validate_credentials函数中添加密码复杂度检查
   - 最少8个字符
   - 包含大小写字母和数字
2. 添加单元测试至tests/validation.rs
3. 更新错误提示文案,保持与[cli/src/login.rs](https://link.gitcode.com/i/4e8e67720d6fd0552ead27fc1cfcb548)风格一致

# 验收标准
- 所有测试通过`cargo test -p login`
- 弱密码输入返回Error::InvalidPassword
- 密码验证逻辑覆盖率≥90%

此模板遵循了AGENTS.md中"精确修改现有代码"的原则,通过限制文件路径和明确错误类型,确保AI不会引入无关更改。

2. 新功能开发模板

对于创建新组件的任务,需要提供更详细的架构指导。以下是一个符合Codex最佳实践的示例:

# 任务目标
实现MCP服务器连接状态监控功能

# 技术约束
- 模块位置: codex-rs/mcp-client/src/
- 通信协议: 遵循[protocol_v1.md](https://link.gitcode.com/i/2658fdddf68fa15c2a52ffa1575b4ecb)
- 日志标准: 使用tracing crate,符合[otel_init.rs](https://link.gitcode.com/i/04b7ca184dc3ca081a3758a93d959e9b)配置

# 实现步骤
1. 创建connection_monitor.rs文件
   - 定义ConnectionMonitor结构体
   - 实现start()和stop()方法
2. 添加状态追踪:
   - 连接超时阈值: 30秒
   - 重连策略: 指数退避算法
3. 集成现有客户端:
   - 修改[rmcp_client.rs](https://link.gitcode.com/i/cbc10a396c37033c156badb24acefa65)添加监控钩子
   - 确保监控线程在ClientDrop时正确终止

# 验收标准
- 通过`cargo run --bin mcp-monitor-test`验证状态切换
- 网络中断后5秒内检测到连接异常
- 资源使用: 空闲时CPU占用<1%

这个模板体现了Codex提示设计中的"高内聚低耦合"原则,明确了新代码与现有模块的交互点,避免了架构上的冲突。

模板使用注意事项

路径规范

Codex要求所有文件引用使用项目相对路径,如cli/src/main.rs而非绝对路径。这一规范在protocol_v1.md中有详细说明,确保代码在不同环境中的可移植性。

权限声明

根据沙箱模式要求,当需要执行特权操作时,必须在提示中明确声明。例如:

# 特殊权限请求
- 需要网络访问: 是(用于下载依赖)
- 文件系统写入: 仅允许target/和tmp/目录
- 理由: 运行集成测试需要编译测试二进制文件

这符合gpt_5_codex_prompt.md中关于权限升级的说明,特别是第51-53行强调的"必须提供权限请求理由"。

测试要求

高质量的提示必须包含可执行的验证步骤。Codex推荐使用以下格式描述测试要求:

# 验证步骤
1. 单元测试: `cargo test -p cli --test login_commands`
2. 集成测试: `./scripts/test_connection.sh`
3. 手动验证: 
   ```bash
   codex login --username test --password Test123!

预期输出: "登录成功"


这种结构化测试要求与[exec/src/cli.rs](https://link.gitcode.com/i/93b6f1e4cf57e464f7484ffeb045360d)中定义的测试框架兼容,确保AI生成的代码能够通过项目的验证流程。

## 高级技巧与工具支持

### 利用AGENTS.md规范

项目中的[AGENTS.md](https://link.gitcode.com/i/42f9b98a4b06eba097fb83cee6cde523)定义了代码风格和结构的指导原则,在提示中引用相关条款能显著提升AI输出质量:

风格指南

  • 遵循AGENTS.md第23-25行关于命名规范的要求
  • 错误处理符合第36行"根因修复"原则
  • 文档字符串格式参考第40行示例

这种引用方式确保AI遵循项目特有的开发规范,减少后续代码评审的修改成本。

### 多文件协作模板

对于跨多个文件的复杂任务,可以使用"主文件+关联文件"的描述方式:

主要修改文件

  • src/core/mod.rs: 添加新的trait定义
  • src/cli/commands.rs: 实现命令行接口

关联文件

  • tests/integration.rs: 添加端到端测试
  • docs/commands.md: 更新使用文档

这符合Codex的模块化开发理念,在[codex-rs/core/src/mod.rs](https://link.gitcode.com/i/2b6d74b1beabc687d43f4cef7c60a723)的设计中可以看到类似的模块化思想。

## 总结与最佳实践

编写有效Codex提示的核心在于:
1. **结构化**:使用清晰的标题层级组织信息
2. **精确性**:限定文件路径和技术选项
3. **可验证性**:提供明确的测试步骤
4. **合规性**:遵循AGENTS.md和协议规范

通过本文提供的模板和示例,开发者可以显著提升与Codex协作的效率。建议将常用模板保存为项目中的docs/prompt-templates.md(若不存在可创建),以便团队共享和维护。

记住,优质的提示是充分发挥Codex能力的关键。随着项目演进,应定期更新提示模板,使其与最新的[CHANGELOG.md](https://link.gitcode.com/i/f1802eb63d99289216673f9b07185435)保持同步,确保AI始终遵循项目的最新规范和最佳实践。

下一篇我们将探讨"使用Codex进行重构的风险控制策略",敬请关注。如需深入了解本文内容,可参考:
- 官方文档:[README.md](https://link.gitcode.com/i/4d66bc427b7bf0a881bff9ef95d7ff01)
- 协议规范:[docs/protocol_v1.md](https://link.gitcode.com/i/2658fdddf68fa15c2a52ffa1575b4ecb)
- 工具调用API:[codex-rs/cli/src/mcp_cmd.rs](https://link.gitcode.com/i/c5e606e876beb23ce6aab5be86d9c3c4)

【免费下载链接】codex 为开发者打造的聊天驱动开发工具,能运行代码、操作文件并迭代。 【免费下载链接】codex 项目地址: https://gitcode.com/GitHub_Trending/codex31/codex

Logo

欢迎加入DeepSeek 技术社区。在这里,你可以找到志同道合的朋友,共同探索AI技术的奥秘。

更多推荐