跳转至

安装

Node.js 版本

Compodoc 只使用 LTS 版本进行测试: v12.x, v14.x

Angular-CLI

Compodoc 支持最新的 Angular-CLI 版本:13.x

只需在一个新的或现有的项目中运行 Compodoc。

全局安装

从 npm 安装:

1
npm install -g @compodoc/compodoc

如果你在 Windows 上使用 PowerShell，请添加引号:

1
npm install -g "@compodoc/compodoc"

本地安装

使用 Angular CLI 安装:npm scripts + 特殊的 tsconfig.doc.json 文件将被创建。

1
ng add @compodoc/compodoc

或直接

1
npm install --save-dev @compodoc/compodoc

运行

创建一个名为tsconfig.doc.json的文件，包含一个指向src文件夹的键include，你也可以使用exclude键:

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

在你的 package.json 中定义一个脚本任务(使用 npm 6.x):

1
2
3
"scripts": {
  "compodoc": "npx compodoc -p tsconfig.doc.json"
}

并像正常的 NPM 脚本一样运行它:

1
npm run compodoc

或与 npx:

1
npx @compodoc/compodoc ...

请参阅usage了解更多细节。

tsconfig 文件在代码库中的位置

Compodoc 从-p选项提供的 tsconfig 文件的文件夹级别启动。

Angular CLI 项目的例子:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
.
├── src
│ ├── app
│ │ ├── app.component.ts
│ │ └── app.module.ts
│ ├── main.ts
│ └── ...
├── tsconfig.app.json
├── tsconfig.doc.json
└── tsconfig.json