在前端开发中，经常需要解析 JavaScript 的注释，这时候可以使用 doctrine 这个 npm 包。它是一个用于解析 JSDoc 注释的工具，可以提取出注释中的参数、返回值、描述等信息，方便我们从注释中获取代码的相关信息。
安装
使用 npm 可以很方便地安装 doctrine：
npm install doctrine --save-dev
基本使用
下面是一个简单的例子，演示如何使用 doctrine 解析注释：
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ---- - - --- - ------- - - ------ -------- - ----- - ------ -------- - ----- - -------- -------- ----- -- -------- ------ -- - ------ - - -- - -- ---- --- --- ----- --- - ------------------------------ - ------- ---- --- -----------------
上面的代码定义了一个求两个数和的函数 add，并为其添加了一条 JSDoc 注释。然后使用 doctrine.parse() 方法解析了这个函数的注释，并将解析结果输出到控制台。
输出结果如下：
-- -------------------- ---- -------
-
-------------- ----------
------- -
-
-------- --------
-------------- --------
------- -
------- -----------------
------- --------
--
------- ---
--
-
-------- --------
-------------- --------
------- -
------- -----------------
------- --------
--
------- ---
--
-
-------- ----------
-------------- --------
------- -
------- -----------------
------- --------
-
-
-
-可以看到，doctrine.parse() 方法返回了一个包含了注释信息的对象。其中 description 属性保存了注释的描述，tags 属性保存了各个参数、返回值等标签的信息。
高级用法
除了基本用法之外，doctrine 还提供了一些高级功能，使其更加灵活和强大。下面列举了一些常用的技巧：
指定标记解析器
doctrine 默认支持 JSDoc 注释的语法，但也可以使用自定义的标记解析器来支持其他注释格式。例如下面的代码使用 Markdown 的注释风格，并指定了对应的解析器：
-- -------------------- ---- -------
----- -------- - --------------------
----- ------ - ------------------
----- ---- - -
----- - ---------
---- ---- ---
- ----- ----------
- ----- ----------
---- ----- ---
----------
-------- ------ -- -
------ - - --
-
-- ---- --- ---
----- --- - ------------------------------ -
------- -----
----- -
- ----- -------------- ------ ----- --
- ----- -------- ------ ---- --
- ----- ---------- ------ ----- -
--
--------------- -
- ----- -------- ------ ---- --
- ----- ---------- ------ ----- -
--
-------- -
------- ----- ----- -- ------------------------ --------------- -- -----------
-
---
-----------------上述代码中，除了使用 doctrine.parse() 方法解析注释之外，还指定了一些参数：
tags：用于覆盖默认的标记类型，这里关闭了description和returns标记的解析。tagDefinitions：自定义标记类型，这里添加了param和returns标记的定义。parsers：自定义标记
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/41220