JsDoc：我如何只记录一个对象

Question

在 JSDoc 中，如何实际记录一个对象，而不是作为一个参数？

例子

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,
    };
  };

这个对象不属于任何函数，只是函数内部的一个对象，但不用作参数

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: ''
};