SuperAPI AI 工具集

wdk-review-types-jsdoc

通用与其它

查看项目

更新于 10-16 08:11

技能介绍

用途:审查指定路径(未提供时默认当前项目 src/ 目录)下的 WDK 模块源码,检查 JSDoc 与类型注解是否符合规范,并给出修正建议。规则与仓库无关,每个模块同等适用;若现有代码与规则冲突,以修改代码为准。

主要能力:按规则编号(如 R1、TD1)逐条报告违规,包含违规规则、文件与行号、问题代码及带修正代码的建议;结果按文件分组,最后汇总各规则违规总数。规则覆盖 JSDoc 格式(描述需先于标签、@param/@property 破折号分隔、默认值写在描述中、私有成员仅用 /** @private */、@protected 完整文档、覆写方法完整 JSDoc、接口用 @implements、@throws 用具体错误类、@see 外部链接、@abstract/@interface、判别联合类型、结构化返回类型用 @typedef 等),类型导入导出规则(用单行 @typedef 导入类型、使用短别名、优先从 index.js 导入),类型精度阶梯(优先具体 @typedef > SDK 类型 > Record<string, unknown>,禁止裸 Object)、命名与大小写约定、以及 .d.ts 更新约定。

使用方式:调用该技能并在提示中提供待审查源码路径;技能会应用全部规则并输出分组后的违规清单与汇总。

适用场景:WDK 模块合并前的类型与文档规范审查。

限制:面向 WDK 模块,需提供源码路径;规范条款较多,具体执行细节以规则原文为准。