Compodoc是Angular应用程序的一个文档生成工具。它生成应用程序的静态文档，可帮助开发人员快速理解当前项目。可用于Angular、Nestjs、Stencil框架，包含8中内置主题，4种语言选项。
示例
compodoc.github.io/compodoc-de…
下载
npm install -g @compodoc/compodoc
npm install --save-dev @compodoc/compodoc
运行
在package.json中定义一个任务。
"scripts": {
"compodoc": "npx compodoc -p src/tsconfig.app.json"
}
复制代码npm run compodoc
用法
compodoc <src> [option]
示例：
"scripts":{
"compodoc": "./node_modules/.bin/compodoc -p tsconfig.json -w -s --language=zh-CN"
}
复制代码下面列出常用的配置属性：
| 属性 | 说明 |
|---|---|
| -c, --config [config] | .compodocrc, .compodocrc.json, .compodocrc.yaml 或者在 package.json中的compodoc属性 |
| -p, --tsconfig [config | tsconfig.json文件 |
| -d, --output [folder] | 输出目录 |
| -y, --extTheme [file] | 外部主题文件 |
| -n, --name [name] | 文档名称 |
| -o, --open | 打开生成的文档 |
| -s, --serve | 在http://localhost:8080/自动打开文档 |
| -r, --port [port | 更改服务端口 |
| --language [language] | 指定文档语言(en-US, fr-FR, zh-CN, pt-BR) (default: en-US) |
| --theme [theme] | 选择一个主题(gitbook-默认，laravel, original, material, postmark, readthedocs, stripe, vagrant) |
| --hideGenerator | 生成的文档菜单栏底部隐藏compodoc logo |
全部属性请访问compodoc.
配置文件
你可以在项目根目录创建一个 .compodocrc, .compodocrc.json, .compodocrc.yaml 或者在 package.json中定义compodoc属性。
{
...
"doc": "npx compodoc -p src/tsconfig.app.json -n \"My app documentation\""
...
}
复制代码npm run doc
文档主要内容
Overview项目主要内容统计概览。图形化展示主要模块、组件、指令等README由项目根目录README.MD生成Dependencies项目第三方依赖列表Modules所有模块的列表。生成有模块依赖图列表Components独立组件Directives独立指令Classes独立类列表Injectables使用 Injectables 装饰器修饰的独立类列表Interfaces所有接口定义列表Pipes管道列表Routes路由树图。路由定义需指定类型为Routes(从@angular/router导入)Miscellaneous其他杂项内容集合。根据这里的内容，可以分析分散的重复定义的内容，不合理的杂项定义等Documentation coverage文档覆盖率信息
注释
Compodoc支持JSDoc注释语法，注释会在模块、组建、指令等info页面生成description，同时支持为每个模块、组件、指令等单独编写markdown文件，生成在页面选项卡中。也可为整个项目添加外部markdown文件。需创建包含markdown文件的文件夹，并包含summary.json文件，使用--includes命令扩展文档。
summary.json
[
{
"title": "A TITLE",
"file": "a-file.md"
},
{
"title": "A TITLE",
"file": "a-file.md",
"children": [
{
"title": "A TITLE",
"file": "a-sub-folder/a-file.md"
}
]
}
]
复制代码主题
默认（Gitbook）
Material Design
Laravel
Readthedocs
Stripe
Vagrant
Postmark
Original