如何在JSDoc中记录'参数列表'数组?

时间:2015-04-10 12:33:32

标签: javascript arrays jsdoc jsdoc3 jsdoc2md

在JavaScript中常见的是使用基本上是参数列表的数组:一个小的固定长度,以及每个位置的已知类型。对于ECMAScript 6尤其如此,它引入了rest operator, spread operatoriterator protocol等功能。

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

/**
 * @returns { { next: function(): {done: boolean, value: [string, *]} } }
 */

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

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

{
    next: function () {
        return {
            done: false,
            value: ['answer', 42]
        };
    }
}

0 个答案:

没有答案