标签: jsdoc2md

如何在JSDoc中记录“类似参数列表”数组?

在JavaScript中,通常使用本质上是参数列表的数组:固定长度较小,并且每个位置的类型都已知。ECMAScript 6尤其如此,它引入了诸如rest运算符, spread运算符iterator协议之类的功能

我想记录一个返回迭代器对象的函数,用于迭代键/值对。理想情况下,我想具体说明其类型。是否可以使用(任何)JSDoc执行此操作?这是我的最新尝试,但我不知道它是否有效:

/**
 * @returns { { next: function(): {done: boolean, value: [string, *]} } }
 */
Run Code Online (Sandbox Code Playgroud)

jsdoc-to-markdown 抱怨语法,但这可能是他们的目的,而不是JSDoc3。如果是这样,我稍后将向他们发送错误报告。

编辑:这是可能返回的示例对象:

{
    next: function () {
        return {
            done: false,
            value: ['answer', 42]
        };
    }
}
Run Code Online (Sandbox Code Playgroud)

javascript arrays jsdoc jsdoc3 jsdoc2md

5
推荐指数
0
解决办法
792
查看次数

标签 统计

arrays ×1

javascript ×1

jsdoc ×1

jsdoc2md ×1

jsdoc3 ×1