如何为Angular应用程序生成文档?

编写软件文档是很困难的。不仅如此，维护软件文档更加复杂，而且常常被人遗忘。

那么，解决方案是什么呢?使用自动化的解决方案如何:

1. 从代码注释生成文档，不需要Wiki或任何第三方软件。
2. 自动生成上述文档，并且可以作为构建过程的一部分。
3. 向开发人员提供指标和反馈，鼓励他们编写更多的文档。

这样的解决方案是存在的。它被称为Compodoc．Compodoc可以从应用程序中编写的所有注释中生成一个类似javadoc的网站(您可以看到这里是此类文档的示例)：

Compodoc可以通过npm全局安装:

             
             

              npm安装- g@compodoc/ compodoc
             
代码语言:CSS（css）

或者你也可以在本地将它添加到单个Angular项目中ng添加项目文件夹中的原理图:

             

              ng添加@compodoc/ compodoc
             
代码语言:CSS（css）

然后你就可以创建一个配置文件来决定包含哪些文件(例如，你可能想要排除test，并且Compodoc已经准备好只用一个命令就可以运行:

             

              npxcompodoc- ptsconfig. doc. json
             
代码语言:CSS（css）

上面的命令创建了一个静态HTML网站，记录了整个应用程序的所有模块/组件/管道/指令/服务。

我最喜欢的功能是文档覆盖统计使用一个类似于开发人员所熟悉的测试覆盖率报告的报告，显示应用程序的哪些部分是良好记录的，哪些部分不是。