如何避免 Node JS 函数中 JSDoc 生成的 Global Scope 文档？答案

【问题标题】：How to avoid Global Scope documentation generated by JSDoc on NodeJS functions?如何避免 Node JS 函数中 JSDoc 生成的 Global Scope 文档？
【发布时间】：2018-10-09 11:28:29
【问题描述】：

JSdoc 在我的 nodejs 模块上生成文档。

/**
 Do something
*/
function doSomething(param1, param2) {
  // blah blah
  ...
}

module.exports.doSomething = doSomething;

JSDoc 的生成文件在 Global 范围下生成了注释，我有数百个这样的导出函数。

有没有办法让JSDoc生成按模块文件名分组的文档？

【问题讨论】：

回答我自己的问题。 JSDoc 有 @module 标签来处理使用 CommonJS 的 nodejs 中导出的函数和类。 usejsdoc.org/howto-commonjs-modules.html 不过好像很麻烦。如果有人知道更好的解决方案，请告诉我！谢谢。

标签： javascript node.js global jsdoc

【解决方案1】：

在文件的顶部，您需要像这样包含一个 jsdoc 注释。如果需要，您还可以将模块命名为其他名称。

/**
 @module FileNameOrCustomModuleName
*/

我认为你不能在一个文件中包含多个 @module 指令。

【讨论】：