SuperAPI AI 工具集

jsdoc-tsdoc

编程与开发

查看项目

更新于 10-15 18:52

技能介绍

用途:为 TypeScript / JavaScript 公共 API 编写符合规范的文档注释。TSDoc 面向 TypeScript,类型由语言本身提供,注释只描述行为;JSDoc 同时承担 JS 文档与类型标注,含 @type、@param {Type}。TypeScript 项目应优先使用 TSDoc。

主要能力:覆盖块标签(@param、@returns、@throws、@example、@remarks、@see、@deprecated、@defaultValue、@typeParam)、修饰标签(@public、@internal、@alpha、@beta、@readonly、@override)和行内标签({@link Target}、{@link Target | text}、{@inheritDoc Parent.method})。可对函数与接口编写注释,接口属性支持 @defaultValue 与 @example。

使用方式:将 /** 注释直接置于声明上方;复杂 API 提供 @example;弃用需给出替代方案。完整参考见 advanced.md(JavaScript 类型标注、TypeDoc / API Extractor 配置、ESLint 插件与 README 模板)。可用 mcp__documentation__fetch_docs 并指定 technology: jsdoc 获取标签参考。文档生成使用 TypeDoc 或 API Extractor 工具本身。

适用场景:TypeScript / JavaScript 公共 API 文档与文档生成流程。

不适用:纯 JavaScript 项目改用 jsdoc 技能;非 API 的普通代码注释不属 TSDoc 范围。

常见反模式:在 TS 中重复标注类型;照抄函数签名;复杂 API 缺 @example;@deprecated 未写迁移方式;遗漏 @throws。

排错:悬停不显示文档检查注释格式;tsdoc 报错按规范修正标签;TypeDoc 忽略注释需将 JSDoc 紧贴声明;{@link} 无法解析改用完整限定名或导入路径。

官方参考:TSDoc https://tsdoc.org/、JSDoc https://jsdoc.app/、TypeDoc https://typedoc.org/、API Extractor https://api-extractor.com/。收费、平台与安装命令暂未提供。