SuperAPI AI 工具集

jsdocs

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:为 Effect 公共 API 编写符合规范的 JSDoc,使其通过 jsdocs oxlint 规则校验。适用于新增或修复 JSDoc 注释、解决 jsdocs 校验问题。

主要能力:按固定文档结构重写注释,包含简短描述、When to use、Details、Gotchas、Example 及 @category、@since 等标签;支持单 API 修复与模块级文档精修;提供 @see 审计与 Gotchas 审计;更新已有 JSDoc 时保留正确事实与示例,将用法、行为细节和注意事项归入对应段落。

使用方式:编辑前先查看声明、实现、附近测试与 JSDoc,判断是单 API 修复还是模块精修;按模板重写注释;对模块精修、复杂 API 或存在相关替代方案时执行 @see 与 Gotchas 审计;最后运行最窄范围验证。验证命令:在含生成文档的包目录运行 pnpm docgen,并运行 pnpm lint(linter 含检查公共 API JSDoc 的自定义规则)。纯文字类技能编辑无需广泛验证。

限制:公共 JSDoc 正文须用英文;不使用 @example,不在 Example 段外放 ts 代码围栏;模块级注释、@internal 与默认导出被忽略;标签顺序与各声明类型的标签要求有明确规定;示例应输出稳定、确定,避免依赖堆栈、时序、随机等。具体规则细节以资料为准,未提供更多平台或收费信息。