SuperAPI AI 工具集

explaining-code

通用与其它

查看项目

更新于 10-15 16:48

技能介绍

用途:帮助用户理解代码或系统如何运作,以及某项改动做了什么。先给出行为层面的技术说明,点出关键函数、组件、数据、API 和职责边界;对可能不熟悉的术语加以解释,保留必要细节,去掉铺垫和废话。

选择层级:系统各层有各自词汇。编排层谈请求、任务、会话;管道层谈字段、载荷、解析器;系统层谈缓冲区、指针、锁、生命周期。先确定层级,再在首句和图示中使用该层名词。问某功能如何工作,按问题层级回答;讲改动,按被改代码的层级解释。仅当读者需要信任该解释时,才在下一句降一层讲机制,需更深入则等读者追问。

解释改动:凡使代码行为不同者(diff、提交、PR、修复、方案等)默认用图示块展示,先一句话说明改动,图紧随其后。被替换、重路由或移除的行为,用同一视图、布局和标签画出 Before 与 After;新增行为只画结果;重点是精确文本(签名、配置值、模式字段)时用聚焦 diff。图中用浅色线条画未变部分,用强调字形画变化部分,并在因果处标注延迟、计数或错误等后果。

其他视图:逻辑或算法用伪代码,运行时顺序用调用树,UI 归属用组件树,文件归属用浅层文件树,交互、数据流、状态或架构用围栏图示块。图示块使用可移植的 Unicode 线稿。结构视图保持窄而具体,每个视图都要增加信息而非重复文字。图无法表达的原因、边界情况和风险放在图后说明。

限制:资料未提供安装方式、收费信息或适用平台,暂未提供。