jsDoc - 如何指定数组长度

Wil*_*ilt 8 javascript arrays specifications maxlength jsdoc

jsDoc我可以指定我的数组参数和成员,如下所示:

/**
 * @constructor
 * @param {Array.<string>} myArray
 */
function someFunction( myArray ){

    this.firstArray = myArray;

    /** @member {Array.<float>} */
    this.secondArray = [];

}
Run Code Online (Sandbox Code Playgroud)

有没有还指定的方式length,或minLengthmaxLength这些阵列的?

Bin*_*Ury 8

虽然指定数组的大小[限制]是不可能的,但对于固定长度的数组,例如“元组”,可以使用类型表达式:

\n
/**\n * @returns {[number, number, number]}\n */\nfunction getLuckyThree() { \xe2\x80\xa6 }\n
Run Code Online (Sandbox Code Playgroud)\n


Jef*_*ams 5

我想您是在问是否可以在类型表达式中包含最小/最大长度(例如Array.<string>)。

简而言之,答案是否定的。您需要在每个阵列的说明中记录最小/最大长度。

  • 我需要准确描述数组长度。有没有办法做到这一点? (2认同)