SuperAPI AI 工具集

jsdocs

编程与开发

查看项目

更新于 10-15 23:46

技能介绍

用途:为 Effect 公共 API 编写、插入或更新符合 jsdocs oxlint 规则的 JSDoc 注释,适用于新增或修复 JSDoc、解决 jsdocs 检查问题。

主要能力:按固定文档结构生成注释,包含简短描述、When to use、Details、Gotchas、Example 及 @category、@since 等标签;支持单 API 修复与模块级文档整理;提供 @see 审计与 Gotchas 审计;要求英文散文、动作优先描述、示例标题唯一且使用确定性输出。

使用方式:编辑前先查看声明、实现、附近测试与已有 JSDoc,判断是单点修复还是模块整理;按模板重写注释并保留正确事实与示例;可运行示例用 import.meta.vitest 标记,从仓库根目录执行 pnpm doctest --run <source files>;运行 pnpm lint 检查公共 API JSDoc 规则。

适用场景:Effect 公共 API 文档维护、模块文档质量提升、JSDoc 规则报错修复。

限制:模块级注释、@internal 项与默认导出被忽略;不使用 @example;不在 Example 外放 ts 代码围栏;{@link} 只能指向 TypeScript 符号;示例需稳定、自包含、不依赖网络或随机性;若发现疑似实现或类型缺陷,不应在文档整理中修改运行时代码,只报告。具体收费、平台与效果暂未提供。