JSDoc错误? 模块导出显示为全局

JSDoc错误?:模块导出显示为全局

嗨,我正在试图logging一个我已经考虑到模块化的小项目。 为此,我有以下代码结构:

/├──app
│└──模块
│└──申请
│├──app
││└──Application.Common.js
│└──cln
│└──Application.GlobalDocumentation.js
│└──ModuleA
│└──ModuleB
/ ……。
└──package.json

我有一个名为Application的模块,它将成为其余模块之间的粘合剂,其中一个职责是定义其余模块(ModuleA,ModuleB等)需要实现的公共接口。
我创build了文件Application.GlobalDocumentation.js仅用于文档目的,以logging这个全局接口(目前它只是一个函数)。

/** * Client-side Constructor Function that generates client side index interfaces * @name ClientModuleConstructor * @function * @global * @param {string} something * @return {object} */ 

而Application.Common.js是共享逻辑将被放置的文件:

 /** * This module handle the initialization, construction and the lifecycle of the application * @module ApplicationCommon */ var requiredModule = require('fs') /** * WHY THIS DOCUMENTATION APPEARS AS GLOBAL?! * @param {Array<ClientModuleConstructor>} applicationModuleConstructors Parameter details * @return {string} */ export default function (applicationModuleConstructors) { return { something: applicationModuleConstructors }; }; 

问题:

  1. 我不知道为什么Application.Common.js文件的导出文档显示为全局的,就是那个文件/模块。
  2. 我应该如何logging一个模块的输出是带有签名ClientModuleConstructor的函数?
  3. 以前的代码片段有问题吗?

笔记:

  • 我正在使用jsdoc 3.4.1

提前致谢。