SuperAPI AI 工具集

jsdoc-typescript-docs

编程与开发

查看项目

更新于 10-15 12:12

技能介绍

用途

JSDoc TypeScript Documentation 用于为 TypeScript 代码库创建全面的内联文档。它面向需要为公开 API、类型定义和组件编写注释并生成文档的开发者,帮助把代码中的类型信息与说明文字结合,产出类型安全的文档。

主要能力

该技能覆盖以下文档对象:

  • 函数:记录参数、返回值、示例,支持异步函数、泛型函数和重载函数。
  • 类型:记录接口(interface)、类型别名(type)、枚举(enum)。
  • 类:记录类、静态工厂方法、私有构造函数、泛型方法等。
  • React 组件:记录组件 Props 接口与组件本身。

支持的 JSDoc 标签包括:@param、@typeParam、@returns、@throws、@example、@see、@remarks、@deprecated、@since、@version、@alpha、@beta、@public、@internal、@readonly、@virtual、@override、@sealed、@defaultValue、@eventProperty 等。

文档生成方面,提供 TypeDoc 配置示例(typedoc.json)以及 package.json 脚本,可输出 HTML 或 Markdown 文档,并支持 typedoc-plugin-markdown、typedoc-plugin-mdn-links 等插件。

使用方式

  1. 在 TypeScript 源码中按规范编写 JSDoc 注释,为每个公开导出添加说明、参数、返回值和示例。
  2. 配置 TypeDoc:在 typedoc.json 中设置 entryPoints、out、name、readme、plugin、excludePrivate、excludeProtected、excludeInternal、includeVersion、categorizeByGroup、categoryOrder、navigationLinks、validation 等选项。
  3. 在 package.json 中添加脚本,例如 "docs": "typedoc" 和 "docs:watch": "typedoc --watch",并安装 typedoc、typedoc-plugin-markdown、typedoc-plugin-mdn-links 等开发依赖。
  4. 运行脚本生成文档,并可将文档生成集成到 CI 流程中。

适用场景

  • 为 TypeScript 库或应用编写公开 API 文档。
  • 为 React 组件库生成 Props 说明与用法示例。
  • 在 CI 中自动生成并校验文档完整性。
  • 需要类型安全、与代码同步的文档输出。

限制

资料未提供该技能的具体安装命令、运行环境要求、收费方式、价格、平台支持范围以及实际使用效果等信息,这些内容暂未提供。