npm 包 esdoc-exclude-source-plugin 使用教程

前言

ESDoc 算是目前比较主流的 JavaScript 文档生成工具。它本身提供了许多可以满足大部分前端开发者的功能，但有时候有些需求需要手动进行插件扩展，比如防止生成文档时出现源代码等。

本文就是想介绍一下如何使用一个 npm 包叫做 esdoc-exclude-source-plugin，该插件可以排除源代码不生成到文档中。

安装

首先需要全局安装 ESDoc：

npm install -g esdoc

然后安装插件：

npm install esdoc-exclude-source-plugin --save-dev

使用

在 ESDoc 的配置文件中加入该插件即可：

{
  "source": "./src",
  "destination": "./docs",
  "plugins": [
    {"name": "esdoc-exclude-source-plugin"}
  ]
}

然后运行 ESDoc 即可生成文档：

esdoc

生成的文档将不会包含源代码。

示例代码

假如有以下测试代码：

/**
 * 计算两个数字的乘积
 * @param {number} a - 数字1
 * @param {number} b - 数字2
 */
function multiply(a, b) {
  return a * b;
}

生成文档后，乘积的函数将只有下面这一段注释信息：

multiply(a, b)
计算两个数字的乘积

结语

ESDoc 的插件机制还是很强大的。esdoc-exclude-source-plugin 的使用只是其中之一。在实际的项目中，还可以根据需求开发适合自己的插件。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eae81e8991b448dc34f