导语
esdoc 是一款 JavaScript 文档生成工具，可以生成漂亮的 HTML 文档，它支持 ES6 的语法，支持自定义主题等等特性。但是在大型项目中，我们可能会使用大量的模块，而在 esdoc 中，模块的使用默认是只会生成模块的名称，而不会生成模块中具体的函数、类等等。如果要生成具体的信息，需要在生成的时候手动添加配置，非常麻烦。因此，我们需要使用 esdoc-named-import-plugin 这个 npm 包来处理这个问题。
esdoc-named-import-plugin 是什么
esdoc-named-import-plugin 是一款 esdoc 的插件，它解决了在文档中只生成模块名称的问题，可以让我们自动的将模块中的命名导入视为命名导出，并生成相关的文档信息。
安装与使用
首先，我们需要安装 esdoc 和 esdoc-named-import-plugin:
$ npm i -D esdoc-es7-plugin esdoc-named-import-plugin
然后，在 .esdoc.json 中添加如下配置:
-- -------------------- ---- -------
-
--------- --------
-------------- ---------
---------- -
-
------- -------------------
--------- -
------ ----
-
--
-
------- ---------------------------
-
-
-其中，esdoc-es7-plugin 是 esdoc 的官方插件，用来支持 ES6 和 ES7 的语法，也可以通过其他插件来实现这个功能。esdoc-named-import-plugin 是我们要使用的插件。在 plugins 数组中，我们需要将它放在 esdoc-es7-plugin 的后面。
接下来，我们就可以使用 esdoc 来生成我们的文档了:
$ ./node_modules/.bin/esdoc
生成的文档将会在 ./docs 目录下。在文档中，我们就能看到命名导入的相关信息了。
示例代码
为了更好的理解这个插件的使用和效果，我们来看一下示例代码:
-- -------------------- ---- ------- -- --------- ------ ----- --- - -- -- - ------------------- -- ------ ----- --- - -- -- - ------------------- -- ------ ----- --- - -- -- - ------------------- --
在这个模块中，我们导出了三个函数: foo, bar, baz。这个模块也是我们需要生成文档的模块。
// main.js
import { foo, bar, baz } from './module';
foo();
bar();
baz();在这个模块中，我们通过命名导入的方式，导入了模块中的三个函数。我们使用 these three 函数，来测试我们的文档生成效果。
通过配置好的 esdoc 和 esdoc-named-import-plugin，执行 esdoc 生成文档之后，我们就能在文档中看到 module.js 中三个函数的文档了。如下图所示:
结语
这篇文章介绍了 esdoc-named-import-plugin 这个 npm 包的使用方法，希望对大家有所帮助。在实际的项目中，我们可能会用到更多的插件来定制化我们的文档生成效果。如果想要了解更多的内容，可以去官网查看文档: https://esdoc.org/。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056c6f81e8991b448e5ef1