SuperAPI AI 工具集

jsdocs

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:面向 Effect 公共 API 的 JSDoc 编写与审查,适用于撰写或审阅 Effect API 文档、完善模块文档、修复文档相关诊断。

主要能力:先检查声明、实现、附近 JSDoc、测试与调用点;按需加载参考文档:标签、模块或链接见 declarations.md,分类见 categories.md,示例见 examples.md。做聚焦的 API 修复或模块完善,保留已验证事实与有价值示例,避免机械重写。对模块完善或存在相近替代的 API,审查 @see 链接,并检查实现与测试以找出具体 Gotchas。

使用方式:运行 pnpm jsdocs --check 及所有适用的根校验命令。公共声明使用多行块,含一个自包含的实用描述段落;函数与方法以现在时动作开头,值则匹配附近名词族措辞。可选非空章节按此顺序各出现一次:When to use、Details、Gotchas。描述、章节、示例与标签之间用一个空行分隔。When to use 陈述与描述不同的正面用例;Gotchas 仅用于具体注意事项与失败模式。

限制:@internal 声明与默认导出不在公共 JSDoc 编写范围内;被检查文件不支持导出枚举或空导出声明。任务完成条件为:每个改动的公共声明满足所有适用参考,检查器通过,可运行示例通过其目标 doctest,其他适用根检查通过或报告为未运行。