如何避免在NodeJS函数上由JSDoc生成的全局作用域文档

How to avoid Global Scope documentation generated by JSDoc on NodeJS functions?

本文关键字：全局 文档 作用域 JSDoc 何避免 NodeJS 函数      更新时间：2023-09-26

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

/**
 Do something
*/
function doSomething(param1, param2) {
  // blah blah
  ...
}
module.exports.doSomething = doSomething;

JSDoc生成的文件在全局作用域下生成了注释，我有数百个这样的导出函数。

是否有办法使JSDoc生成按模块文件名分组的文档?

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

/**
 @module FileNameOrCustomModuleName
*/

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

相关文章：