前言
在前端开发过程中，代码的可读性和可维护性是非常重要的，因此我们需要好的文档来帮助我们理解和修改代码。而 esdoc 是一个非常好的 JavaScript 文档生成工具，它可以生成漂亮而且易于阅读的文档。
虽然 esdoc 已经很好用了，但是默认情况下它会将 JavaScript 代码也一并包含在文档中，导致文档体积过大，也不利于代码保密和管理。幸运的是，npm 包 esdoc2-exclude-source-plugin 可以有效地解决这个问题。
本文介绍了如何使用 esdoc2-exclude-source-plugin 生成文档并排除 JavaScript 代码。
安装
使用 npm 安装 esdoc2-exclude-source-plugin：
npm install esdoc2-exclude-source-plugin --save-dev
配置
在 esdoc.json 配置文件中添加一个新的插件，并配置需要排除的文件：
{
"source": "./src",
"destination": "./doc",
"plugins": [
{"name": "esdoc2-exclude-source-plugin", "option": {"src": ["**/*.js", "!**/*~"]}}
]
}上面的配置文件指定了源代码目录为 ./src，文档输出目录为 ./doc，并且配置了一个名为 esdoc2-exclude-source-plugin 的插件，其中 src 表示需要排除的文件，这里将默认排除所有 .js 文件和以 ~ 结尾的文件。
示例代码
为了演示效果，我们编写了一个简单的 JavaScript 文件 index.js：
-- -------------------- ---- ------- --- - - ------ ---------- ------ ---- ---- --- -------- - ------- --- -- --- - ---- --- ------- --------- - --------- - ------ -------- - - --- ----- ------- - ------ -------- - - --- ------ ------- - -------- -------- - --- --- -- --- --- -------- -- ------ -------- ------ -- - ------ - - -- -
将上述代码保存到 ./src 目录下，并执行以下命令：
npx esdoc
执行完成后，在 ./doc 目录下会生成一个漂亮的文档网站，其中不包含我们的 JavaScript 源代码：
总结
在本文中，我们介绍了如何使用 esdoc2-exclude-source-plugin 来生成文档并排除 JavaScript 代码。通过本文的学习，我们可以更好的理解如何使用 npm 包来进行前端开发，同时也能更好地提高代码的可读性和可维护性。
希望这篇文章对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b381e8991b448e2fad