JsDoc：如何仅记录 object

Question

在 JSDoc 中，如何实际记录 object，而不是作为参数？

例子

let object1 = {
  name: '' //string,
  age: '' //number,
};

真实的例子

 /**
   * Update User
   * @param {Object} params
   * @param {String} params.oldName
   * @param {String} params.oldAge
   */
  const onChangeUser = params => {
    ....

    //I want to document this object
    let object1 = {
      // name: '', string,
      // age: '' number,
    };
  };

这个 object 不属于任何 function 只是 object 在 ZC1C425268E68384D1AB5074 中使用，但不用作 paramC425268E68384D1AB5074

Answer 1

可以使用typedef @documentation给复杂类型起别名

/**
 * @typedef PersonProperties
 * @type {object}
 * @property {string} name - Full Name of the Person.
 * @property {number} age  - Age of Person.
 */

用法：

/** @type {PersonProperties} */
let object1 = {
  name: '',
  age: ''
};