用途：为 TypeScript 项目生成生产级文档，适合在编写 API 文档、为模块补充注释、记录架构决策、搭建文档生成流水线、编写 React 组件说明或创建 API 参考时使用。
主要能力：
- 配置 TypeDoc：建立 typedoc.json，设置入口点与输出目录。
- 编写 JSDoc：为公开 API 添加 @param、@returns、@example 等标签。
- 生成 ADR：记录架构决策的背景、决定与后果。
- 搭建流水线：在 CI/CD 中自动生成文档。
- 编写可运行示例、使用 @see 与 @link 交叉引用，并用 ESLint 的 JSDoc 规则校验完整性。
使用方式： 安装依赖：npm install --save-dev typedoc typedoc-plugin-markdown Angular 可加装：npm install --save-dev @compodoc/compodoc 生成文档：npx typedoc 可配置 package.json 脚本，如 docs:generate 执行 typedoc、docs:validate 运行校验脚本。
适用场景： NestJS、React、Express 等框架的 API 与组件文档、泛型与联合类型说明、接口文档、认证与安全相关注释。
限制与注意事项： 私有成员应使用 @private 或从 TypeDoc 输出中排除；泛型约束与类型参数需说明；破坏性变更用 @deprecated 附迁移指引；文档中不得包含密钥或凭据；示例代码应可运行且经过测试；@see 引用需有效；文档版本应与代码版本同步。上述内容依据公开资料整理，具体收费、平台支持等暂未提供。