🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
## 文档 **Compodoc**是 `Angular` 应用程序的文档工具。 `Nest` 和 `Angular` 看起来非常相似,因此,**Compodoc**也支持 `Nest` 应用程序。 ### 建立 在现有的 `Nest` 项目中设置 `Compodoc` 非常简单。 安装[npm](https://www.npmjs.com/)后,只需在 `OS` 终端中使用以下命令添加 `dev-dependency` : ```bash $ npm i -D @compodoc/compodoc ``` ### 生成 在[官方文档](https://compodoc.app/guides/usage.html)之后,您可以使用以下命令( `npx`需要`npm 6` )生成文档: ```bash $ npx compodoc -p tsconfig.json -s ``` 打开浏览器并导航到 `http://localhost:8080` 。 您应该看到一个初始的 `Nest CLI` 项目: ![img](https://docs.nestjs.com/assets/documentation-compodoc-1.jpg) ![img](https://docs.nestjs.com/assets/documentation-compodoc-2.jpg) ### 贡献 您可以[在此](https://github.com/compodoc/compodoc)参与 `Compodoc` 项目并为其做出贡献。