SuperAPI AI 工具集

explain

通用与其它

查看项目

更新于 10-15 21:42

技能介绍

用途:对指定文件、函数/方法、概念或数据控制流程给出清晰解释,包括代码如何运作、为何采用某种模式、模块或系统做什么、架构决策与取舍。

主要能力:按范围区分文件、函数、概念、流程;按复杂度提供三档深度——简单(快速摘要要点)、标准(用途、运作方式、关键决策)、深入(完整拆解、替代方案与权衡)。输出结构化,含“它做什么”“如何运作”“关键决策(决策/原因/替代方案)”“使用示例”“相关代码”,并可附加学习笔记。

使用方式:通过斜杠命令调用,例如 /explain src/auth/middleware.ts、/explain the handleWebhook function in payments.ts、/explain how our event sourcing works;可用 --simple、--deep 指定深度,用 --learn 获取额外背景。收集上下文时给出示例命令,如 head -50 "$FILE"、grep -A 30 "function $NAME|def $NAME|fn $NAME" "$FILE"、ls -la "$DIR",以及读取 index.ts 或 init.py。

适用场景:理解陌生代码、评估设计决策、新成员上手、学习架构模式。建议更具体地指定行范围、说明自身技术背景,并通过追问和类比加深理解。

限制:资料未提供安装方式、收费、价格、平台支持及效果数据;上述命令为通用示例,实际可用性暂未提供。