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

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

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

module.exports.doSomething = doSomething;

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

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

解决方法:

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

/**
 @module FileNameOrCustomModuleName
*/

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

上一篇:修改博客园主题


下一篇:博客园主题 Silence的配置