介绍
tjsdoc-plugin-external-ecmascript 是一个 npm 包，它是 TJSDoc 的插件之一。TJSDoc 是一种用来描述 TypeScript 代码的标记语言，有点像 JSDoc。tjsdoc-plugin-external-ecmascript 可以帮助我们在 TJSDoc 中引用 ECMAScript 规范中的类型定义。
安装
可以通过 npm 安装 tjsdoc-plugin-external-ecmascript：
npm install tjsdoc-plugin-external-ecmascript --save-dev
使用
配置
在这篇文章中，我们将使用一个 TypeScript 文件来展示 tjsdoc-plugin-external-ecmascript 的使用。我们假设这个 TypeScript 文件中使用了 Array.prototype.find 方法，我们想在 TJSDoc 中使用这个方法的类型定义。
首先，需要在 tsconfig.json 中配置 TJSDoc：
{
"compilerOptions": {
"plugins": [{ "name": "tjsdoc" }]
}
}然后，在 .tjsdocrc 中配置 tjsdoc-plugin-external-ecmascript：
-- -------------------- ---- -------
-
------------------ -
---------- -
-
------- ------------------------------------
---------- -
---------- -
-------- -----
-
-
-
-
-
-在这个示例中，我们配置了 targets.array 的值为 "es6"，表示需要引用 ECMAScript 6 中的 Array 类型定义。tjsdoc-plugin-external-ecmascript 目前支持以下 targets：
- "array"
- "map"
- "set"
- "weakmap"
- "weakset"
- "promise"
更多信息请参考 tjsdoc-plugin-external-ecmascript 的文档。
TJSDoc
在 TypeScript 文件中，我们可以添加 TJSDoc 注释来描述代码。
下面是 Array.prototype.find 方法的 TJSDoc 注释示例：
-- -------------------- ---- ------- --- - ------- --- ----- -- --- ----- ------- -- --- ----- ---- --------- --- -------- ------- --------- - - ---- ------ -------------------------------------------------------------------------------------------- - - --------- - --- ------- ---- -- --- ------ - - ------ --------- -- ------ ------- ---- ---- -- --------- --------- - - -------- ---- ------- ----- --------- --- ------- - ----- ---- -- --------- -- --- ------- ----- ------ -- -------- - - -------- --- - ----------- - --- ----- -- --- ----- ------- -- --- ----- ---- --------- --- -------- ------- --------- -- ----------- -- -- ---- ------- -- ------ --
在注释中，我们使用了 {@link} 标记来添加链接，以引用 Array.prototype.find 方法的文档。
使用
现在，在我们的项目中，我们可以使用 Array.prototype.find 方法的类型定义了。
下面是一个示例 TypeScript 类：
-- -------------------- ---- -------
---
- ---------- - ----- -- -------
--
----- ----- -
---
- --- ------- -- --- ------
-
- ----- ----------
--
-------- ---------
---
- ----- - ------ -- ----- -----
-
- ------ -------- ---- --- ---- -- --- ------ -- -----
- -------- -------- - -----------
- --- ------ ---- --- ----- ----- -- --------- -- -- ---- ------ -------
--
---------------------- -------- ------ - --------- -
------ -------------------------- -- ----------- --- ------
-
-
---
- ---------- - -------
--
----- ------ -
---
- --- ---- -- --- -------
-
- ----- --------
--
----- -------
---
- ------- - --- -------
-
- ------ -------- ---- --- ---- -- --- -------
--
----------------- ------- -
--------- - -----
-
-在这个类中，我们使用了 Array.prototype.find 方法来查找一个成员。
在 TJSDoc 注释中，我们使用了 Array.prototype.find 方法的类型定义：返回值类型是 (Person | undefined)。
结论
tjsdoc-plugin-external-ecmascript 可以帮助我们在 TJSDoc 中引用 ECMAScript 规范中的类型定义，可以让我们更加方便地描述 TypeScript 代码。
在这篇文章中，我们介绍了 tjsdoc-plugin-external-ecmascript 的安装和使用，并展示了一个例子，以及如何在类中使用 Array.prototype.find 方法的类型定义。
如果你想了解更多关于 TJSDoc 的信息，请访问 官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055d3081e8991b448daede