如何避免JSDoc在NodeJS函数上生成的全局范围文档？

Question

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

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

module.exports.doSomething = doSomething;

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

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

Answer 1

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

/**
 @module FileNameOrCustomModuleName
*/

我认为您不能在单个文件中使用多个@module指令。