NestJS Logo
NestJS 中文文档
v10.0.0
  • 介绍
  • 快速上手
  • 控制器
  • 提供者
  • 模块
  • 中间件
  • 异常过滤器
  • 管道
  • 守卫
  • 拦截器
  • 自定义装饰器
  • 自定义提供者
  • 异步提供者
  • 动态模块
  • 依赖注入作用域
  • 循环依赖
  • 模块引用
  • 懒加载模块
  • 执行上下文
  • 生命周期事件
  • 发现服务
  • 跨平台无关性
  • 测试
迁移指南
API 参考
官方课程
  1. 文档
  2. 实用案例
  3. Compodoc

CQRS
Sentry

文档

Compodoc 是一款为 Angular 应用设计的文档生成工具。鉴于 Nest 与 Angular 在项目和代码结构上的高度相似性,Compodoc 也完全适用于 Nest 应用。

安装

将 Compodoc 集成到你的 Nest 项目中非常简单。首先,运行以下命令来安装开发依赖:

npm install -D @compodoc/compodoc

生成文档

运行以下命令即可为你的项目生成文档(请注意,你需要 npm 6 或更高版本才能使用 npx)。如需了解更多选项,请参阅其官方文档。

npx @compodoc/compodoc -p tsconfig.json -s

完成后,在浏览器中访问 http://localhost:8080,你将看到如下所示的项目文档首页:

Compodoc 1
Compodoc 2

参与贡献

欢迎在这里为 Compodoc 项目做出贡献。