简介
espree-extract-comments 是一个基于 Espree 的 npm 包，用于从 JavaScript 代码中提取注释。它可以方便地将注释提取为单独的对象，并支持各种类型的注释，例如：单行注释、多行注释、JSDoc 注释等。
在前端开发中，我们经常需要分析代码中的注释来获取关键信息，比如 API 文档、代码作者、时间戳等等。使用 espree-extract-comments 可以快速简洁地实现这个目标。
安装
你可以通过 npm 来安装 espree-extract-comments：
npm install espree-extract-comments
或者，你也可以将其添加到项目的 package.json 文件中：
{
"dependencies": {
"espree-extract-comments": "^1.0.0"
}
}使用方法
基本用法
首先，我们需要引入 espree-extract-comments：
const extractComments = require('espree-extract-comments');然后，我们可以使用 extractComments 函数来提取注释：
-- -------------------- ---- ------- ----- ---- - - -- -------- -- - -------- -- --- - ---- ----- -- -- -------- ------- -- -- ----- -------- - ---------------------- ----------------------
上面的代码将打印如下结果：
-- -------------------- ---- -------
-
-
------- -------
-------- - ----------
-------- --- ----
------ -
-------- - ------- -- --------- - --
------ - ------- -- --------- -- -
-
--
-
------- --------
-------- - ---------- --
-------- ---- ----
------ -
-------- - ------- -- --------- - --
------ - ------- -- --------- - -
-
--
-
------- --------
-------- --- - ---- ----- ---- --
-------- ---- ----
------ -
-------- - ------- -- --------- - --
------ - ------- -- --------- - -
-
-
-从上面的结果可以看出，返回的注释是一个数组，其中每个元素都是一个对象，包含以下属性：
type：注释类型，可能的值为"Line"、"Block"和"Shebang"。value：注释内容。range：注释在代码中的范围，由起始和结束位置组成的数组。loc：注释在代码中的位置信息，包括开始和结束行数以及列数。
自定义选项
除了基本用法之外，espree-extract-comments 还支持一些自定义选项，以便更好地适应不同的使用场景。以下是一些常用的选项：
attachComment：是否将注释附加到相邻的代码节点中，默认为false。lineCommentTypes：单行注释类型的列表，默认为["Line"]。blockCommentTypes：多行注释类型的列表，默认为["Block"]。shouldExtractComment：一个函数，用于判断是否提取注释的条件，默认返回true。
下面是一个示例代码，演示了如何使用这些选项：
-- -------------------- ---- ------- ----- ---- - - -------- ------- - -- ----- ---- - -- ----- -------- - --------------------- - -------------- ----- ----------------- --------------- ------------------ -------------- --------------------- ------ ----- -- ------------------- - ----------------------------------------------------------- -------- ----------------------------------------------------------------------------------