@microsoft/api-documenter 是一款由微软开发的文档生成器，可以生成针对 Typescript 模块的详细 API 文档。
在前端开发过程中，API 文档是一个必不可少的工具，可以让开发者快速理解和使用某个模块的方法和属性。本篇文章将为各位前端开发者详细介绍 @microsoft/api-documenter 的使用方法和步骤。
安装
在使用 @microsoft/api-documenter 前，需要先安装它并将其添加为开发依赖项。
可以通过下列命令进行安装：
npm install --save-dev @microsoft/api-documenter
配置
接下来，需要配置 api-documenter 的配置文件。可以在项目的根目录下创建一个名为 api-documenter.json 的配置文件，然后在该文件中输入下面的内容：
-- -------------------- ---- -------
-
---------- --------------------------------------------------------------------------------------------
----------------- ---------
----------- -
----------------- ------------------
-------------------------- --
--
--------------------- -
---------- ------
----------------------------- ---
------------------- ------------------
----------------- ---
------------- -----
--------------- --
--
----------- -
---------- -----
--------------- ---------
---------------------- -----
-------------- ----------------------------
-
-"markdownEngine"：指定使用哪种 Markdown 引擎。"compiler"：指定哪个 TypeScript 编译器配置文件用于文档生成。"apiReportGenerator"：控制是否在文档中生成 API 报告，以及生成该报告必须使用的选项。"markdown"：控制是否输出 Markdown 文件以及输出这些文件必须使用的选项。
构建
安装了依赖和配置文件后，接下来就可以开始生成文档了。在根目录下执行以下命令：
node_modules/.bin/api-documenter run
这个命令将会按照上面提到的配置文件，生成 API 文档。
使用
当你构建完毕后，就可以在指定的输出路径中找到生成的文档了。默认是 ./docs/index.md。在生成文档前，可以在任何需要的地方目录中任何位置使用 JSDoc 注释。注释应当用于 API 的任何公共成员（函数，类，属性等）。
以下是 JSDoc 文档注释的一个简单示例：
-- -------------------- ---- -------
---
- ---------- - ----- -- --------------- ------
--
------ ----- ----- -
---
- ----------- - --- -------- -- --- ------- ------
- ------ - - --- - -----------
- ------ - - --- - -----------
--
------------------ -- ------- ------ -- ------- --
---
- ---------- --- --------- -------- ---- ---- ----- -- --- --------- ------
- ------ ----- - --- ----------- ------
- -------- --- -------- ---- ---- ----- -- --------
--
----------------- ------- ------ -
----- -- - ------- - -------
----- -- - ------- - -------
------ -------------- ----
-
-总结
本篇文章介绍了如何使用 @microsoft/api-documenter 生成高质量的 TypeScript API 文档。您可以使用此工具来生成 API 文档，通过完善的文档帮助开发者快速理解项目，提高开发效率，减少出错率。希望这篇文章能够为您提供帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/170072