SuperAPI AI 工具集

explain

编程与开发

查看项目

更新于 10-13 16:42

技能介绍

用途

Explain 用于获取对代码、文件、目录或架构概念的全面解释。它基于代码分析而非文档,适合理解陌生代码库、梳理模块边界与数据流。

主要能力

  • 自动检测并分类目标:文件、函数/类、目录或概念。
  • 并行收集上下文:查找用法、评估规模、定位相关测试/类型/文档,并加载 AGENTS.md、CLAUDE.md 中的项目约定。
  • 按文件类型与内容路由到预加载相关 -ops 技能的通用智能体,例如 .ts 预加载 typescript-ops、.tsx 预加载 react-ops、.py 按主题预加载 python-* 技能、.vue 预加载 vue-ops、.sql/迁移预加载 postgres-ops、Claude 扩展预加载 claude-code-ops;所有解释器均预加载 debug-ops 用于系统化分析。
  • 生成结构化 Markdown 解释,包含 mermaid 图表(flowchart/sequence/class)、file:line 形式的相关代码引用、设计决策与理由。

使用方式

基本调用为 /explain <target> [--depth] [--focus],其中 target 可以是文件路径、函数名、类名、目录或概念。

深度模式:

  • --shallow:概述段落与关键导出,无图表。
  • --normal:完整解释、一张图表、主要概念(默认)。
  • --deep:详尽覆盖所有内部细节、边界情况、历史与多张图表。
  • --trace:追踪数据在整个系统中的流动,配合序列图。

聚焦模式:

  • --focus arch:模块边界、层次分离、依赖。
  • --focus flow:数据流、控制流、状态变化。
  • --focus deps:导入、外部依赖、集成。
  • --focus api:公共接口、输入/输出、契约。
  • --focus perf:复杂度、瓶颈、优化机会。

示例:

  • /explain src/auth/oauth.ts
  • /explain validateToken
  • /explain src/services/
  • /explain src/core/engine.ts --deep --focus arch
  • /explain handleUserLogin --trace
  • /explain src/utils/helpers.ts --shallow
  • /explain package.json --focus deps

工具集成与降级

使用现代 CLI 工具并具备降级方案:tokei(代码统计,降级为跳过统计)、ast-grep(结构化搜索,降级为 rg 模式)、bat(语法高亮,降级为 Read 工具)、rg(内容搜索,降级为 Grep 工具)、fd(文件查找,降级为 Glob 工具)。

集成与持久化

可与 /review(理解后审查)、/testgen(为已解释代码生成测试)、/save(保存相关任务进度)配合。重要解释完成后可选择追加到 ARCHITECTURE.md、追加到 AGENTS.md(若与约定相关)或仅输出不保存,以便将有价值的架构知识保留在 git 跟踪文档中。

限制与说明

解释基于代码分析,不基于文档;复杂系统可能需要多次调用 /explain;不熟悉的代码库建议使用 --deep;mermaid 图表可在 GitHub、GitLab、VSCode 及多数 Markdown 查看器中渲染。具体收费、价格与平台信息暂未提供。