API Extractor

API Extractor

API Extractor可帮助您编写更好的TypeScript库：它分析您导出的类型签名，并且（1）生成一个API文档网站，（2）生成一个.d.ts“汇总”文件，以及（3）创建一个API报告以促进PR评论。
API Extractor可帮助TypeScript开发人员管理其库的API表面。它作为NPM软件包“ @ microsoft / api-extractor”分发。它产生三种不同的输出类型：-API报告-API提取器可以跟踪项目主入口点的所有导出，并生成报告以用作API审查工作流的基础。-.d.ts汇总-与Webpack如何将所有JavaScript文件“汇总”到单个分发包中一样，API Extractor可以将TypeScript声明汇总到单个.d.ts文件中。可以对该文件进行修整以排除使用TSDoc标记（例如@beta”或@internal）标记的声明。-API文档-该工具会为您的每个项目生成一个“文档模型” JSON文件。该JSON文件包含提取的类型签名和doc注释：“ api-documenter”配套工具可以使用这些文件来生成API参考网站，也可以将它们用作自定义文档管道的输入。
api-extractor

网站:

特征

分类目录

具有任何许可的所有平台的API Extractor替代品

Compodoc

Compodoc

Compodoc是Angular应用程序的文档工具。它为您的应用程序生成静态文档。功能：
ESDoc

ESDoc

一个很好的JavaScript文档生成器。功能：-文档覆盖率测量-文档皮棉-测试代码集成到文档中。
TypeDoc

TypeDoc

TypeScript项目的文档生成器。
Docma

Docma

Docma是一个功能强大的工具，可以轻松地从Javascript（JSDoc），Markdown和HTML文件生成漂亮的HTML文档。
Dgeni

Dgeni

dgeni-AngularJS，Protractor和其他JS项目使用的灵活的JavaScript文档生成器
Smartcar

Smartcar

在Smartcar，我们使开发人员能够构建移动性的未来。