介绍
esdoc-undocumented-identifier-plugin 是一个 npm 包，它是 ESDoc 的插件之一。该插件用于检测 JavaScript 代码中未记录在 API 文档中的标识符。如果您是前端开发人员，您可能已经使用过 ESDoc 来生成 JavaScript 代码的 API 文档。但是，有时会出现遗漏或忘记记录某些标识符的情况，这就是这个插件的作用。它可以帮助您找到这些遗漏的标识符并提醒您添加文档。
安装
首先，请确保您已经安装了 Node.js 和 npm。然后，您可以使用以下命令进行安装：
npm install --save-dev esdoc-undocumented-identifier-plugin
使用方法
配置文件
要使用 esdoc-undocumented-identifier-plugin，您需要在 ESDoc 的配置文件中添加一个配置项。示例配置文件如下：
{ "source": "./src", "destination": "./docs", "plugins": [ {"name": "esdoc-undocumented-identifier-plugin", "option": {"access": ["public"]}} ] }
在上面的配置中，我们将 esdoc-undocumented-identifier-plugin 添加为 ESDoc 插件。我们还使用了 option 来指定了插件的一些选项，例如只检测公共的 API。
示例代码
让我们来看一个示例代码，它包含了一些未记录在 API 文档中的标识符：
-- -------------------- ---- ------- --- - ---- -- - ------ ------- - ------- ------ -- --- - - ------ ------ -- ----- ----------- - --- - ------ - --- -------- -- ------------ - ------ -------- ---- - --- ---- -- --- ------- -- ----------------- - --------- - ----- - --- - --- --- ---- -- --- ------- - -------- -------- --- ---- -- --- ------- -- --------- - ------ ---------- - --- - - ------ -------- ---- -- --- ---- -- --- ------ ---- -- ----------------- - -- -- --------- ----- - - --- - - ------ --------- - ------ -------- - - --- - ----------- - ------ -------- - - --- - ----------- - -------- -------- --- --- -- - --- -- -- -------- ----------------- -- - ------ - - -- -展开代码
在上面的代码中，_helperFunction 是未记录在 API 文档中的标识符。要使用 esdoc-undocumented-identifier-plugin 检查此类遗漏，您可以运行以下命令：
npx esdoc --watch
运行上述命令后，您将会看到类似以下输出：
[esdoc-undocumented-identifier-plugin] found undocumented identifier: SampleClass#_helperFunction()
这意味着您需要将 _helperFunction 添加到您的 API 文档中。
总结
esdoc-undocumented-identifier-plugin 是一个非常有用的工具，它可以帮助检测 JavaScript 代码中未记录在 API 文档中的标识符。通过使用该插件，您可以确保您的 API 文档是完整的，并且没有遗漏。希望本文能够对您有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/47253
