TypeDoc #

┌─────────────────────────────────────────────────────────────┐
│                        TypeDoc                               │
├─────────────────────────────────────────────────────────────┤
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐         │
│  │  类型解析    │  │  自动文档    │  │  主题定制   │         │
│  └─────────────┘  └─────────────┘  └─────────────┘         │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐         │
│  │  插件系统    │  │  Markdown   │  │  搜索功能   │         │
│  └─────────────┘  └─────────────┘  └─────────────┘         │
└─────────────────────────────────────────────────────────────┘

✅ TypeScript 原生支持
   - 自动解析类型
   - 无需额外注解
   - 类型信息完整

✅ 丰富的注解标签
   - @param 参数说明
   - @returns 返回值说明
   - @example 使用示例
   - @deprecated 弃用说明

✅ 美观的输出
   - 现代化主题
   - 响应式设计
   - 搜索功能

✅ 可扩展
   - 插件系统
   - 自定义主题
   - Markdown 支持

npm install --save-dev typedoc

npx typedoc src/index.ts

{
  "entryPoints": ["src/index.ts"],
  "out": "docs",
  "plugin": ["typedoc-plugin-markdown"],
  "theme": "default"
}

TypeDoc 文档
├── 核心功能
│   └── 注解标签
│
├── 配置选项
│   ├── 入口配置
│   ├── 输出配置
│   └── 插件配置
│
└── 高级用法
    ├── 自定义主题
    └── 插件开发

/**
 * 用户服务
 * 
 * 提供用户管理相关的功能。
 * 
 * @example
 * ```typescript
 * const service = new UserService();
 * const user = service.getUser(1);
 * ```
 */
class UserService {
  /**
   * 获取用户信息
   * 
   * @param id - 用户ID
   * @returns 用户对象
   * @throws {NotFoundError} 用户不存在时抛出
   * 
   * @example
   * ```typescript
   * const user = service.getUser(1);
   * console.log(user.name);
   * ```
   */
  getUser(id: number): User {
    // ...
  }
}

入门阶段
├── TypeDoc 简介
├── 安装配置
└── 基本使用

进阶阶段
├── 注解标签
├── 配置选项
└── 输出定制

高级阶段
├── 自定义主题
├── 插件开发
└── CI/CD 集成