Question

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

您好，我正在尝试记录我所拥有的一个小型项目，该项目是以模块化的方式构建的。出于这个原因，我有以下代码结构：

/├──应用
│└──模块
│└──申请
│├──应用
││└──Application.Common.js
│└──cln
│└──Application.GlobalDocumentation.js
│└──模块A
│└──模块B
/ ...。
└──package.json

我有一个名为Application的模块，它将成为其余模块中的粘合剂，其职责之一是定义其余模块（ModuleA，ModuleB等）需要实现的公共接口。 /> 我创建了文件Application.GlobalDocumentation.js仅用于文档目的，以记录此全局接口（目前只是一个函数）。

/**
* 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
    };
};

问题：

我不知道为什么Application.Common.js文件的导出文档显示为全局，只是该文件/模块。
我应该如何记录模块的导出是具有签名ClientModuleConstructor的函数？
以前的片段有问题吗？

注意：

我正在使用jsdoc 3.4.1

提前致谢。

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

0 个答案: