SuperAPI AI 工具集

explain-code

编程与开发

查看项目

更新于 10-16 05:50

技能介绍

用途:当需要解释代码如何运作、通读代码库某一区域,或用户询问“这是如何工作的”时使用本技能。

主要能力与讲解方式:讲解时通常包含四部分。一是先用类比,把代码比作日常生活中的事物;二是画图,用 ASCII 图示展示流程、结构或关系;三是逐步走查,说明每一步发生了什么;四是提示常见坑,指出容易犯的错误或误解。讲解保持对话式口吻,遇到复杂概念会使用多个类比。

可用的图示类型包括:流程与控制流,如 Input -> [Validate] -> [Process] -> [Save] -> Output,并分支 [Error] -> Return 400;调用栈与序列图,用 Client、API、DB 之间的箭头表示请求、查询、结果与响应;树形与层级结构,如 App 下的 Header、Nav、Main、Sidebar、Content、Footer;状态机,如 [Idle] --submit--> [Loading] --success--> [Done],失败则进入 [Failed] 并可 --retry--> 回到 [Loading];数据结构,如 User 包含 id、profile、posts,并标出嵌套关系;前后对比,用 Before/After 两列展示重构差异。

错误处理约定:若代码引用了外部文件或模块,应先读取它们再讲解;若图示过于复杂,应拆成多个聚焦的图,每张只覆盖一个概念。

适用场景:代码走查、代码库局部梳理、向他人解释实现逻辑、回答代码工作机制类问题。

限制:资料未提供安装方式、收费、价格、平台支持、输出格式细节或具体使用命令,这些暂未提供。