用途:为 TypeScript 项目生成面向不同读者的多层结构文档,涵盖 API 文档、架构决策记录(ADR)与框架特定写法。
主要能力:TypeDoc 配置与 API 文档生成;覆盖 TypeScript 各类构造的 JSDoc 写法;ADR 的创建与维护;NestJS、React、Express、Angular、Vue 的框架特定模式;用于文档质量的 ESLint 校验规则;GitHub Actions 流水线搭建。
使用方式:安装依赖 npm install --save-dev typedoc typedoc-plugin-markdown,配置 entryPoints、out、theme、excludePrivate、readme 等选项后运行 npx typedoc;Angular 可用 npx compodoc -p tsconfig.json;用 eslint --ext .ts src/ 校验文档;在 JSDoc 中使用 @param、@returns、@throws、@example、@remarks、@see、@deprecated 等标签;可在 CI 中运行 npm run docs:generate 与 npm run docs:validate。
适用场景:创建 API 文档、架构决策记录、代码示例,以及为上述框架编写框架特定文档模式。
限制与注意:私有成员应使用 @private 或从 TypeDoc 输出中排除;复杂类型需记录泛型约束与类型参数;破坏性变更使用 @deprecated 并给出迁移指引;文档中绝不包含密钥或凭据;@see 引用需指向有效位置;示例代码应可运行并经过测试;文档版本需与代码版本保持同步。校验失败时应查看 ESLint 报错、补全 JSDoc 描述与 @param/@returns/@throws,重新运行 eslint --ext .ts src/ 直至通过。官方资料未提供具体收费、价格与平台信息。