【问题标题】:What type should I use to document ES6 module parameters in jsdoc?我应该使用什么类型在 jsdoc 中记录 ES6 模块参数?
【发布时间】:2019-07-03 16:20:48
【问题描述】:

假设我像这样导入ES6 module

import * as moduleVar1 from "./variant/One.js";
import * as moduleVar2 from "./variant/Two.js";
import * as moduleVar3 from "./variant/Three.js";

现在,例如使用通常的 switch-case 语句或类似语句以编程方式选择加载的模块之一。选定的模块通过module = moduleVar1(或类似的)保存在一个变量中。

最后,我想将模块传递给另一个函数:

continueFunction(module)

现在,如何在函数中记录参数类型(此处为 continueFunction),以便指定它接受 ES6 模块?

我的意思是,@param {Object} 可能适合,但并不具体。

【问题讨论】:

    标签: ecmascript-6 jsdoc es6-modules jsdoc3


    【解决方案1】:

    您将使用导出类型的标记。例如,如果所有模块都是Number,那么您将使用@param {Number}

    【讨论】:

      猜你喜欢
      • 2013-04-07
      • 2020-02-09
      • 2013-12-13
      • 2018-12-30
      • 2017-01-17
      • 1970-01-01
      • 2017-12-21
      • 2013-05-22
      • 2012-04-27
      相关资源
      最近更新 更多