如何使用 JSDoc 记录元组？答案

【问题标题】：How to document tuple using JSDoc?如何使用 JSDoc 记录元组？
【发布时间】：2021-02-20 15:28:34
【问题描述】：

是否有某种标准来使用 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
}

【问题讨论】：

您可以使用@typedef typescriptlang.org/docs/handbook/…。顺便说一句，从 Typescript 4 开始，您可以标记元组元素 typescriptlang.org/docs/handbook/release-notes/…

标签： typescript jsdoc

【解决方案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
}

【讨论】：