jsdoc二维数组

时间:2014-09-01 09:43:13

标签: javascript jsdoc jsdoc3

我有一个字符串数组数组,我无法弄清楚如何用JSDoc记录它。

/**
@class
*/
function PostbackList() {
    /**
    @type {int}
    @default
    */
    this.TypeID = 0;
    /**
    @type {PostbackList.Field[]}
    */
    this.Fields = new Array();
    /**

    !! Issue here !!


    @type {string[][]}
    */
    this.Values = null;
}

导致错误。

  

无效的类型表达式“string [] []”:预期“!”,“?”或“|”但是“[”   找到。

我不知道是否应该将?放在类型前面以表明它可以为空。

2 个答案:

答案 0 :(得分:15)

根据jsdoc的当前维护者在issue report中所说的,正如我们所说,jsdoc 3无法通过添加方括号来处理声明多维数组。您可以像使用Array.<string[]>或使用Array.<Array.<string>>一样执行此操作。

根据问题报告,版本3.3.0将允许您想要使用的符号。

答案 1 :(得分:1)

Louis答案是有效的,但是维护者updated the repository以及您提供的代码也有效:

@type {string[][]}