生成Angular专用文档

为我们的 Angular 项目自动生成项目说明文档，只需简单几步

安装依赖

yarn add @compodoc/compodoc -D

@compodoc/compodoc 这个第三方库就是来帮我们自动生成文档的

配置

接下来，在项目根目录下创建 tsconfig.doc.json，并写入以下内容

{
	"include": ["src/**/*.ts"],
	"exclude": ["src/test.ts", "src/**/*.spec.ts", "src/app/file-to-exclude.ts"]
}

include 代表为src目录下的所有ts文件生成文档

exclude 代表排除不需要生成文档的文件

修改package.json

在 scripts 新增一条指令

 "scripts": {
"compodoc": "npx compodoc -p tsconfig.doc.json"
 },

生成文档

打开命令行，执行以下命令

yarn compodoc

执行命令后，程序会自动遍历我们的src目录，并生成响应的文档

生成的文档位置在 documentation 文件夹中，这个文件夹也是会被自动创建的，与 src 目录同级