在前端开发过程中，文档是一个必不可少的环节，好的文档可以提高开发效率，并且使得代码更容易维护。而在 JavaScript 中，ESDoc 是一款非常实用的文档工具。本文将介绍如何使用 npm 包 esdoc2-unexported-identifier-plugin，这是一个用于在 ESDoc 中生成未导出标识符文档的插件。
什么是 esdoc2-unexported-identifier-plugin？
esdoc2-unexported-identifier-plugin 是 ESDoc 的一个插件，它可以生成未导出标识符文档。在 JavaScript 中，使用 ES6 的模块化语法可以控制导出的内容，从而提高代码的可维护性。然而，很少有工具能够生成未导出标识符的文档。而 esdoc2-unexported-identifier-plugin 就是为了解决这个问题而产生的。
安装 esdoc2-unexported-identifier-plugin
使用 npm 可以很方便地安装 esdoc2-unexported-identifier-plugin。只需要在命令行中输入以下代码：
npm install esdoc2-unexported-identifier-plugin -D
配置 ESDoc
在安装 esdoc2-unexported-identifier-plugin 之后，需要在 ESDoc 的配置文件中加入它的配置项。首先，在项目根目录下创建一个名为 .esdoc.json 的文件，并加入以下内容：
-- -------------------- ---- -------
-
--------- --------
-------------- ---------
---------- -
-
------- --------------------------------------
--------- -
--------- ---------- ------------ ----------
-
-
-
-其中，source 表示源代码的目录，destination 表示文档的目录。插件的配置通过 plugins 数组来实现，每一个插件都有一个 name 和一个 option。在这里，我们需要设置 name 为 esdoc2-unexported-identifier-plugin，option 中的 access 表示需要文档化的访问类型，包括 public、protected 和 private。如果不需要文档化某种类型的标识符，可以将其从 access 数组中删除。
使用示例
这里我们来看一个例子。假设我们有一个名为 math.js 的文件，它导出了一个名为 add 的函数，以及一个名为 _square 的内部函数。我们希望在文档中记录 add 函数，但是不希望 _square 函数在文档中出现。
-- -------------------- ---- ------- -- ------- --- - ---- --- -------- - ------ -------- - - --- ----- ------- - ------ -------- - - --- ------ ------- - -------- -------- --- ------ -- ------ - --- -- -- ------ -------- ------ -- - ------ - - -- - -------- ---------- - ------ - - -- -
现在，我们使用 esdoc2-unexported-identifier-plugin 来生成文档。首先，在命令行中输入以下命令：
./node_modules/.bin/esdoc
然后，打开生成的文档文件，可以看到 add 函数已经出现了，而 _square 函数没有出现。
结论
通过 esdoc2-unexported-identifier-plugin，我们可以在 ESDoc 中生成未导出标识符的文档，从而提高文档的完整性和可读性，更好地维护代码。希望本文能够对大家有所帮助，同时也希望大家可以继续学习和使用更多的前端工具和技术。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b381e8991b448e2fd6