SuperAPI AI 工具集

explain

编程与开发

查看项目

更新于 10-16 05:42

技能介绍

用途:对指定代码给出清晰、完整的解释,帮助读者理解不熟悉的代码,或把代码讲给他人听。

调用输入:用户可提供文件路径(如 /explain src/auth/jwt.ts)、带行号范围的文件路径(如 /explain src/auth/jwt.ts:45-80)、函数或类名(如 /explain parseToken);也可只输入 /explain,此时解释当前打开或最近讨论的文件。

输出结构:一、概述,用两三句话说明代码的高层作用与解决的问题;二、关键组成部分,按函数拆解,包含用途、参数(名称与类型及含义)、返回值、副作用(如变更、API 调用、状态变化);三、控制流,说明执行路径,如先做什么、再判断什么、条件成立与不成立分别发生什么,复杂逻辑可用简单流程图表示;四、依赖,包括外部库、内部模块、环境变量、数据库或 API 连接;五、陷阱与边界情况,包括不明显的行为、已处理或未处理的边界、性能考量与已知限制;六、用法示例,展示如何调用该代码。

语气与风格:假设读者是有能力的开发者但不熟悉这段特定代码;避免术语,除非先给出定义;为清晰起见使用“这段代码”的表述;简洁但完整。

限制:资料未提供具体支持的编程语言、依赖的模型或平台、收费与价格信息,也未提供安装命令。