共计 949 个字符，预计需要花费 3 分钟才能阅读完成。
Angular 的 API Extractor 是一个用于生成和治理 TypeScript 库的 API 文档的工具。它的工作原理是通过剖析 TypeScript 代码，并提取其中的公共 API，生成清晰的文档以便开发者理解库的应用形式、函数、类、接口等。
API Extractor 的工作流程如下：
- 配置：首先，须要创立一个名为 “api-extractor.json” 的配置文件来领导 API Extractor 的工作流程。配置文件蕴含了一些重要的选项，例如源代码地位、输入目录、文件筛选规定等。
- 入口点：指定库的入口点，通常是一个或多个 TypeScript 文件。API Extractor 将从这些文件开始剖析和提取公共 API。
- 剖析代码：API Extractor 剖析 TypeScript 代码，查找公共的函数、类、接口、枚举等，并确定它们的名称、参数、返回类型以及其余相干的信息。
- 生成申明文件：API Extractor 生成申明文件（.d.ts）以形容库的公共 API。申明文件是 TypeScript 的一种文件类型，它提供了类型信息，以便其余开发者在应用库时取得正确的类型推断和代码提醒。
- 修剪申明文件：API Extractor 能够依据配置中的选项对生成的申明文件进行修剪，以排除某些不须要公开的 API 或公有实现细节。这有助于确保库的公共 API 是清晰和稳固的。
- 生成文档：API Extractor 能够生成各种格局的文档，例如 Markdown、HTML 等。这些文档形容了库的应用形式、函数和类的阐明、参数和返回值的定义等，帮忙其余开发者了解和应用库。
- 校验和公布：API Extractor 提供了一些校验规定，以确保库的 API 合乎统一的命名和标准。这有助于进步代码的品质和可维护性。在生成文档之后，开发者能够抉择公布文档，以便其余开发者能够不便地拜访和应用。
通过应用 API Extractor，开发者能够生成标准和易于了解的 API 文档，提供给其余开发者应用库时参考。这有助于进步代码的可维护性和可重用性，同时也促成团队之间的单干和沟通。
须要留神的是，API Extractor 是一个独立于 Angular 框架的工具，能够与任何基于 TypeScript 的我的项目一起应用。它提供了灵便的配置选项，以满足不同我的项目的需要，并反对定制化的文档生成和校验规定。
正文完
