前言
ESDoc是一个非常好用的文档生成工具，可以为Javascript项目生成整洁易读的文档，但是有时候我们会在代码中使用到一些未被ESDoc识别的标识符（如注释等）。这种情况下，ESDoc便不能正确地生成文档，这时候我们需要使用esdoc2-undocumented-identifier-plugin这个NPM包来解决这个问题。
esdoc2-undocumented-identifier-plugin介绍
esdoc2-undocumented-identifier-plugin是ESDoc的一个官方插件，它可以识别代码中的未被ESDoc识别的标识符，并且将其列入文档中。使用这个插件可以让我们的文档更加完整与准确。
安装esdoc2-undocumented-identifier-plugin
要使用esdoc2-undocumented-identifier-plugin，我们首先需要安装npm包。我们可以在终端中使用以下命令来安装：
npm install esdoc2-undocumented-identifier-plugin --save-dev
配置esdoc2-undocumented-identifier-plugin
在安装完esdoc2-undocumented-identifier-plugin后，我们需要在ESDoc配置文件中将其加入插件列表：
{
"source": "./src",
"destination": "./docs",
"plugins": [{"name": "esdoc2-undocumented-identifier-plugin"}]
}如上面的例子所示，我们只需要在插件列表中加入插件的名称，它就会被自动加载。
示例代码
下面是一个使用了未被识别的标识符的示例代码：
-- -------------------- ---- -------
---
- -------
-
- ------ -------- - - ----
- ------ -------- - - ----
- -------- -------- ----
--
-------- ------ -- -
-- -----
-
---
- --------
-
- ------ ------- ---- - ---
- ------ ------- ---- - ---
- -------- ------- ------
- -------------
--
-------- --------------- ----- -
-- -----
-你会发现这个代码中使用了一个"@undocumented"标记，这个标记告诉ESDoc这个函数是未被文档化的，需要使用esdoc2-undocumented-identifier-plugin插件才能将其正确列入文档中。
总结
使用esdoc2-undocumented-identifier-plugin可以使我们的文档更加准确完整，特别是在代码中使用了一些ESDoc无法识别的标识符时，这个插件可以解决这个问题。安装和配置也非常简单，只需要几步就可以完成。希望这篇文章能帮助你更好地使用ESDoc。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600566b381e8991b448e2fc0