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

Question

JSdoc 生成了关于我的 nodejs 模块的文档。

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

module.exports.doSomething = doSomething;

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

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

Answer 1

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

/**
 @module FileNameOrCustomModuleName
*/

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