前言
在前端开发中，我们常常会用到 TypeScript 来编写代码，并且需要生成 API 文档来方便其他人员阅读。手动编写文档不仅费时费力，还容易出错，因此我们需要一种工具来自动生成 API 文档。ts-docs-gen 就是这样一个工具。本文将详细介绍如何使用 ts-docs-gen 生成 TypeScript 的接口文档。
安装 ts-docs-gen
使用 npm 进行安装：
--- ------- -- -----------
生成 API 文档
- 在项目的根目录下创建一个
tsconfig.docs.json文件，并添加如下配置：
-
---------- ------------------
---------- -
----------
--
---------- -
--------------
-
-- 运行以下命令生成 API 文档：
----------- -------- ------------------ ----- -----------
其中，--config 参数指定了 ts-docs-gen 使用的配置文件路径，--out 参数指定了生成的 API 文档的保存路径。
- 打开
docs/api.md文件即可查看生成的 API 文档。
配置文件说明
ts-docs-gen 支持使用 JSON 或 YAML 格式的配置文件，以下是一个完整的配置文件示例：
----------- - ------------ - --------------- ------- -------- ---------- ---- ------ -- --- ---- ------------------ -----
其中，inputFiles 参数指定了要生成文档的 TypeScript 文件路径，可以使用通配符来匹配多个文件；outDir 参数指定了生成的 HTML 文档的保存目录；publicUrl 参数指定了生成的 HTML 文档在服务端的 URL；title 参数用于设置生成的 HTML 文档的标题；disableGenericTag 参数用于禁用 @generic 标签。
示例代码
以下是一个 TypeScript 类的示例代码：
---
- ----
--
------ ----- ---------- -
---
- ----
-
- ------ - -----
- ------ - -----
- -------- ------
- --------
- -------------
- ----- ---------- - --- -------------
- ----- ------ - ----------------- ---
- -------------------- -- -- -
- ---
--
------ ------- -- -------- ------ -
------ - - --
-
-运行 ts-docs-gen 工具后，会生成如下的 API 文档：
-- ------- --- ---------- ----- ------- ---------- ---- ---- ------- ----- -------- ------ --------- -- ---------- -------- ---- - ------ ----- - ------ ----- - ------------ ------ - ------------ ------------- ----- ---------- - --- ------------- ----- ------ - ----------------- --- -------------------- -- -- -
License
MIT
-- -- -- ----------- -------- ---------- ----------------------------------------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------