用途:为 TypeScript 项目生成 API 文档,把源码中的 TSDoc / JSDoc 注释转换为 HTML 等形式的文档,并可作为参考技能按任务查阅对应资料。
主要能力:涵盖安装与 CLI 用法、Node.js 编程式调用、浏览器打包;注释语法与 JSDoc/TSDoc 兼容性、外部文档、声明引用;块标签(@param、@returns、@example、@category、@group 等)、修饰符标签(@hidden、@internal、@override、@alpha、@beta 等)、内联标签(@link、@inheritDoc、@include 等);typedoc.json、entryPoints、out、theme 等配置选项;默认主题、社区主题与自定义 CSS;社区插件列表;自定义主题、插件开发、国际化与架构;Application、Converter、Renderer、Reflection 等编程式 API。
使用方式:按任务在映射表中找到类别,先读该类别 references/{category}/README.md 定位页面,再读取对应 .md 获取细节;samples 提供典型用法与配置示例,scripts 提供安装、CLI、watch、config、output、validate 等命令说明。
适用场景:需要为 TypeScript 库或项目编写与生成 API 文档、配置 TypeDoc、编写 TSDoc 注释、开发主题或插件时。
限制:本资料为参考技能目录与导航说明,未提供具体版本、收费、价格、平台或效果信息;具体命令与配置细节需查阅对应文件,暂未提供。