jsdoc二维数组

jsdoc two dimensional array

本文关键字:二维数组 jsdoc      更新时间:2023-09-26

我有一个字符串数组的数组,我不知道如何用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[][]":应为"!"、"?"或"|",但应为"["建立

我不知道是否应该将?放在类型前面,以指示它可以为null。

根据jsdoc的当前维护人员在本问题报告中所说的,正如我们所说的那样,jsdoc3无法通过添加方括号来处理声明多维数组。您可以像使用Array.<string[]>Array.<Array.<string>>那样执行此操作。

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

Louis的答案是有效的,但维护人员更新了存储库,现在您提供的代码也是有效的:
@type {string[][]}