SuperAPI AI 工具集

codex-explain

编程与开发

查看项目

更新于 10-16 03:50

技能介绍

用途

codex-explain 用于解释复杂代码,通过 Codex exec 完成。适用场景包括:理解复杂逻辑、追踪数据流、上手不熟悉的代码。

触发关键词:explain code、what does this do、how does this work、code walkthrough。

不适用场景

  • 代码审查:应使用 codex-code-review
  • Bug 排查:应使用 bug-fix 或 issue-analyze
  • 架构总览:应使用 code-explore

主要能力与深度级别

该技能支持三种深度级别:

  • brief:一句话总结。
  • normal:功能概览 + 执行流程 + 关键概念(默认)。
  • deep:在 normal 基础上增加设计模式、复杂度、问题与依赖。

使用方式

工作流程为:读取目标文件 → [收集上下文] → Codex 解释 → 输出说明。

具体步骤:

  1. 读取目标文件:读取文件内容;如指定 --lines,则仅提取该范围。
  2. Codex 解释:按 @skills/codex-code-review/references/codex-transport.md 的说明,以解释提示词启动(参见 references/codex-prompt-explain.md)。

输出结构如下:

## Code Explanation: <target>
- **Depth**: brief / normal / deep
- **Summary**: <functional overview>
- **Execution flow**: <key paths>
- **Key concepts**: <patterns, abstractions>

验证要点:

  • Codex 独立研究项目上下文(导入、调用方)
  • 解释与请求的深度级别相符
  • 关键概念被识别并解释

示例

  • 输入:/codex-explain src/service/order/order.service.ts 动作:读取文件 → Codex 解释(normal)→ 功能摘要 + 详细说明。

  • 输入:/codex-explain src/service/xxx.ts --depth deep 动作:读取文件 → Codex 解释(deep)→ 设计模式 + 复杂度 + 问题。

  • 输入:/codex-explain src/xxx.ts --lines 50-100 动作:读取第 50-100 行 → Codex 解释 → 聚焦解释。

限制

关于该技能的收费、价格、支持平台、具体效果等事实,提供的资料中暂未说明。