如何使用 JSDoc 注释记录具有属性和方法的 JavaScript 对象

我不是 JSDoc 专家，也许我太简单了，但这似乎有效：

/**
 * An object that blah blah blah...
 */
const objectname = {
    /**
     * The numeric property of the object.
     * @type number
     */
    property: 0,
    /**
     * Sets the `property` to the given value.
     * @param {number} value - The value to set the property to.
     * @returns {void}
     */
    set(value) {
        this.property = value;
    },
};

当我在 VS Code 中使用它时，我会在弹出窗口等中获取事物的类型和描述（包括参数类型 on）。set

@param 和 @returns 标记属于 set 方法的 JSDoc 注释中，而不是 ObjectName 的 @typedef 注释中。

VSCode 如果我删除，则有效

    /**
     * An instance of ObjectName.
     * @type {ObjectName}
     */

这是更正后的版本

/**
 * Represents an object with a property and a set method.
 * @typedef {object} ObjectName
 * @property {number} property - The numeric property of the object.
 * @property {Function} set - Sets the property value to the specified value.
 */

const objectName = {
  property: 0,

  /**
   * Sets the property value to the specified value.
   * @param {number} value - The value to set the property to.
   * @returns {void}
   */
  set(value) {
    this.property = value;
  }
};

VSCode：