SuperAPI AI 工具集

understand-explain

编程与开发

查看项目

更新于 11-10 17:20

技能介绍

用途

understand-explain 用于对代码库中的具体文件、函数或模块做深入讲解。它适合在阅读陌生代码、梳理依赖关系、理解架构分层或排查调用链时,获得结合知识图谱与源码的上下文解释。

主要能力

该技能围绕一份知识图谱 JSON 展开。项目元数据包含名称、描述、语言、框架、分析时间与 Git 提交哈希。节点覆盖代码类型(文件、函数、类、模块、概念)与非代码类型(配置、文档、服务、表、端点、流水线、模式、资源),以及领域知识类型(domain、flow、step、article、entity、topic、claim、source),每个节点带有标识、类型、名称、可选文件路径、摘要、标签、复杂度等字段。边描述导入、包含、调用、依赖、配置、文档、部署、触发、流程步骤、关联、引用等关系。此外还有 layers 与 tour 结构用于架构分层和导览。技能会查找目标节点、抓取其出边与入边、读取邻接节点、确定所属架构层,并读取实际源文件,最终解释组件在架构中的角色、内部结构、外部连接与数据流。

使用方式

先解析数据目录:若 .understand-anything 存在则用它,否则用 .ua,并检查 knowledge-graph.json 是否存在;不存在时提示用户先运行 /understand。使用图谱前检查新鲜度:读取 project.gitCommitHash,经 git rev-parse 校验为提交后,与 git rev-parse HEAD 比较,并检查项目范围内的已提交变更、暂存变更、工作区变更和未跟踪文件,命令以当前项目路径为限定;仅在提交差异或工作区命令报告项目文件时,提醒图谱派生上下文可能缺少这些改动,并建议运行 /understand 刷新。定位节点时,对文件路径搜索 filePath,对函数表示法搜索对应文件下的名称字段,记录节点标识、类型、摘要、标签与复杂度;再在边中查找该标识作为 source 或 target 的记录,读取相关节点信息,并在 layers 中确定所属层;最后读取源文件进行解释。

适用场景

适用于需要深入理解某个函数或模块的实现细节、追踪调用与依赖链、了解组件在架构分层中的位置、向不熟悉该编程语言的读者解释代码逻辑,以及结合源码说明输入处理输出流程的场景。

限制

该技能依赖已生成的知识图谱,图谱缺失时无法提供分析,只能提示先运行 /understand。图谱可能落后于代码变更,提交哈希不一致或工作区有改动时需要刷新。Git 元数据缺失、无效或不可用时不阻断流程,只给出简短的尽力提醒。资料未提供其他平台、收费或效果方面的信息。