Skip to main content

JSDoc Array of Objects 的標註方式

單純標註由 Object 組成​

標註這是一個由 object 為元素組成的 array

/**
 * @param {Array.<Object>} myObjects
 */

/**
 * @type {Object[]} myObjects
 */

第二種寫法會更加簡潔

詳細標註由 Type 組成​

/**
 * @typedef {Object} Person
 * @property {string} name - 姓名
 * @property {number} age - 年齡
 */

/**
 * @type {Array.<Person>}}
 */
/**
 * @type {Person[]}
 */
const myArray = [
  { name: "John", age: 32 },
  { name: "Jane", age: 27 },
];