SuperAPI AI 工具集

jsdocs

编程与开发

查看项目

更新于 10-16 07:23

技能介绍

用途:为 Effect 公共 API 编写符合规范的 JSDoc,满足 jsdocs oxlint 规则。

主要能力:按固定文档结构重写注释,包含简短描述(必填,单段)、When to use、Details、Gotchas、Example(标题)等可选段落,并按顺序排列;处理 @see、@deprecated、@default、@category、@since 等标签及其顺序与适用范围;区分根声明、命名空间、成员的不同标签要求;支持单 API 修复与模块级整理。

使用方式:编辑前先查看声明、实现、附近测试与已有 JSDoc;判断是单点修复还是模块整理;按模板重写并保留正确事实与示例;执行 @see 审计与 Gotchas 审计;运行最窄的相关验证。验证命令:在含生成文档的包目录运行 pnpm docgen;运行 pnpm lint(含检查公共 API JSDoc 的自定义规则)。纯文字类技能编辑不运行宽泛验证。

限制:公共 JSDoc 正文须用英文;不使用 @example,不在 Example(标题)外放 ts 代码围栏;{@link} 只能指向 TypeScript 符号,不能指向 URL;不记录模块级注释;@internal 项被忽略;默认导出被忽略;示例需稳定确定,避免依赖堆栈、对象检查、错误格式、并发顺序、时间、随机或环境相关格式;不添加枚举或空导出等不支持结构。

适用场景:新增或修复 Effect 公共 API 的 JSDoc、解决 jsdocs 规则报错、整理模块文档质量。

暂未提供:具体安装命令、收费与价格、平台支持范围等资料未给出。