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 项目做出贡献。