typescript - چگونه از JSDoc برای مستندسازی تاپل استفاده کنیم؟


آیا نوعی استاندارد برای مستندسازی تاپلها با استفاده از 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 {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
}