首页 / NODEJS / javascript – 如何避免JSDoc在NodeJS函数上生成的全局范围文档？

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

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了javascript – 如何避免JSDoc在NodeJS函数上生成的全局范围文档？，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含436字，纯文字阅读大概需要1分钟。

内容图文

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

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

module.exports.doSomething = doSomething;

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

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

解决方法:

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

/**
 @module FileNameOrCustomModuleName
*/

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

内容总结

以上是互联网集市为您收集整理的javascript – 如何避免JSDoc在NodeJS函数上生成的全局范围文档？全部内容，希望文章能够帮你解决javascript – 如何避免JSDoc在NodeJS函数上生成的全局范围文档？所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/765729.html

来源：【匿名】