随着前端技术的飞速发展，将 JavaScript 应用于开发各种类型的应用程序越来越普遍。在 JavaScript 生态系统中，NPM 是最受欢迎的包管理器。许多 JavaScript 框架和库都被上传到 NPM，并且可以轻松地通过 NPM 包安装和使用。
在使用 NPM 安装和使用包时，我们通常需要知道使用方式、参数列表、返回值等信息。这些信息通常包含在类型声明文件中，以使 JavaScript 编辑器更智能并提供更好的代码补全和类型检查。但这些类型声明文件并不总是可用的。
此时，我们可以使用 @types/usage 这个 NPM 包。@types/usage 可以帮助我们分析 JavaScript 代码，生成接口文档，并提供智能模糊搜索功能和代码示例。
安装
在使用 @types/usage 之前，我们需要先安装它。在终端中运行以下命令：
--- ------- -- ------------
安装完成后，我们就可以使用 @types/usage 命令了。
使用
在使用 @types/usage 之前，我们需要先执行以下命令生成分析结果：
-- ------ --- -------- ------------- --------- ------------------------ -------- -- ---- ------- ----------------------------------------------------- -- -------------
这里的 tsc 命令是用于生成 TypeScript 类型声明文件，必须在所有源代码（包括依赖项）都被编译为类型声明文件后才能执行，否则会出现编译错误。
tsconfig.json 的内容如下：
-
---------------- -----
------------------ -
------ ------- -------
--------- -----------
---------------- -----
--------------------- -----
------------ -----
--------- -----
--
---------- ------------
-ts-node 命令是用于运行 TypeScript 脚本文件，使用需要安装 ts-node 包，并执行以下命令安装：
--- ------- -- -------
当完成上述步骤后，再运行以下命令就能够生成文档：
----- ------
这个命令返回文档的帮助信息，以及所有可用选项的说明。其中，--glob 选项是用于指定要分析的文件。
代码示例
以下是一个简单的代码示例，使用 @types/usage 将一个函数 add 的接口文档生成为 Markdown 格式。
---
- --- --------
-
- ---- -------- ------- --- --- -- --- --------
-
- ------ -------- - - --- ----- ------ -- ----
- ------ -------- - - --- ------ ------ -- ----
- ------- -------- --- --- -- - --- --
-
- --------
-
- ------ --- -- -
--
-------- ------ -- -
------ - - --
-
--------- - ---
---------------------------- -----__filename 是 Node.js 全局变量之一，它表示当前模块的文件名。add.usage 可以指定函数的额外信息，如各个参数的说明、返回值的说明等。
以上代码片段可以生成以下 Markdown 格式的文档：
--- -------- ---- -------- ------- --- --- -- --- -------- - ----- ----------- --- ----- ------ -- ---- - ----- ----------- --- ------ ------ -- ---- ------- ----------- --- --- -- - --- -- -----------
add(1, 2); // 3
---------------------- --------------------------------------------------------- -- -- ----------------- ---------- --------------------------------------- --------------------------------------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------