Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 2.9 KB

File metadata and controls

85 lines (63 loc) · 2.9 KB
description Codex IDE 入口说明,介绍编辑器上下文、局部代码修改、代码解释、审查和高频开发协作场景,提升日常效率。

IDE

IDE 入口适合贴近编辑器上下文的高频小任务。它的优势是文件、选区、符号跳转、错误信息和开发者当前注意力都在同一个环境里。

::: tip 最后核对 官方资料最后核对日期:2026-05-27。本文参考 Codex 文档入口 与官方 IDE 相关页面。具体插件、入口和可用功能会随产品更新变化,请以官方页面和当前 IDE 插件说明为准。 :::

IDE 适合什么

  • 解释当前文件或选中代码。
  • 为一个函数补测试。
  • 局部重构。
  • 生成注释、文档或类型说明。
  • 审查当前 diff。
  • 快速理解错误信息和调用链。

::: info 截图占位 请补充 IDE 中选中代码并请求解释的截图。建议文件:docs/.vuepress/public/screenshots/ide/01-explain-selection.png。 :::

选区任务写法

选区越准确,结果越稳定。推荐模板:

请只基于当前选中的代码解释:
1. 它在模块中的职责
2. 输入输出和副作用
3. 可能的边界情况
4. 如果要补测试,建议覆盖哪些场景

如果允许修改:

请只修改当前文件和对应测试文件。

目标:为当前函数补充边界测试。
要求:
1. 先解释测试场景。
2. 修改后运行相关测试。
3. 不做无关重构。

IDE 中的高频任务

任务 推荐输入 结果检查
解释代码 选中函数或类 看是否说清职责和边界
补测试 选中函数和现有测试 看测试是否能失败后通过
修类型错误 粘贴错误信息和文件 看是否影响运行时行为
局部重构 指定文件和目标 看 diff 是否可读、测试是否通过
写文档 选中 API 或配置 看示例是否可执行
Review diff 提供当前 diff 看是否优先发现行为风险

::: info 截图占位 请补充 IDE 中查看 diff 或应用修改的截图。建议文件:docs/.vuepress/public/screenshots/ide/02-apply-diff.png。 :::

和 CLI 的配合

IDE 适合局部上下文,CLI 适合完整验证。建议流程:

  1. 在 IDE 中解释或修改当前文件。
  2. 回到 CLI 运行相关测试。
  3. git diff 检查最终变更。
  4. 需要更大上下文时,让 CLI 读取仓库规则和测试配置。

注意事项

  • 不要用过大的选区开始任务。
  • 局部任务写清“只改当前文件”或“只改对应测试”。
  • 重要改动仍要跑测试。
  • 生成注释时避免重复代码含义,优先解释边界、原因和约束。
  • 涉及敏感配置时不要把 token 或 .env 直接贴入对话。

官方资料