如何使用 JSDoc 记录元组？

Question

是否有某种使用 JSDoc 记录元组的标准？

给出以下代码，这是记录数组中特定索引位置处的值的正确方法吗？

/**
 * @param {Array.<number,number>} tuple_variable description
 * @param {number} tuple_variable[0] description
 * @param {number} tuple_variable[1] description
 */
function document_tuple( tuple_variable: [number,number] ) {
   // omitted
}

Answer 1

如果您想要一个包含每个数组元素的描述的完全扩展版本，则可以使用以下内容：

/**
 * @typedef {number} MyTupleIndex0 - Description of index 0...
 * @typedef {number} MyTupleIndex1 - Description of index 1...
 * @typedef {[MyTupleIndex0, MyTupleIndex1]} MyTuple
 * @param {MyTuple} tuple_variable
 */
function document_tuple(tuple_variable) {
  // ommited
}

或者，更简洁，但没有描述：

/**
 * @param {[number, number]} tuple_variable
 */
function document_tuple(tuple_variable) {
  // ommited
}