用途:审查指定路径(未提供时默认当前项目 src/ 目录)下的 WDK(Wallet Development Kit)模块源码,识别 JSDoc 与类型标注违规并给出修正建议。规则与具体仓库无关,不设“黄金参考”模块,所有模块同等适用;若现有代码与规则冲突,应改代码而非改规则。
主要能力:覆盖 JSDoc 格式(描述须先于标签、@typedef 与 @template 使用 {Object}、@param/@property 需破折号分隔、禁用 [param=value] 默认值写法、@private 使用范围、私有成员仅用 /** @private */、@protected 需完整文档、重写方法须保留父类 JSDoc、@implements 与 @extends 区分)、类型导入导出(用单行 @typedef 导入类型、优先从 index.js 或 SDK 包导入、使用短别名)、类型标注(x[] 与 Record 规范、类型精度阶梯、优先 SDK 类型、别名命名、可空返回加 | null、@throws 按条件拆分、@see、@abstract/@interface、判别联合、@typedef 结构化返回、.d.ts 与运行时一致、清理未用 @typedef、内联对象类型提取、undefined 与 null 约定、@overload 命名)等规则。
使用方式:对每个违规报告所违反规则编号、文件与行号、问题代码、含修正代码的建议;按文件分组,全部审查后给出各规则违规总数汇总。
适用场景:WDK 模块源码的文档与类型规范审查、.d.ts 生成质量保障。
限制:资料未提供具体安装命令、运行环境、收费与平台信息;规则细节以资料所列条目为准。