javascript - 如何使用 JSDocs 描述具有默认值的可选对象参数

Question

我不知道标题是否正确表达了我想要做的事情。但我有以下功能:

/**
 * @param {any} param1
 * How to describe the second parameter??
 * @returns {Object}
 */
function doSomething (param1, { property1 = null, property2 = null }){
  // do stuff
  return something
}

正如评论中所质疑的，使用 JSDocs，我将如何描述第二个参数？

Answer 1

使用方括号[]表示可选参数。就像这样:

/**
 * @param {any} param1
 * @param {Object} somethingWithProps - Some description
 * @param {string} [somethingWithProps.property1] - First property
 * @param {string} [somethingWithProps.property2] - Second property
 * @returns {Object}
 */
function doSomething (param1, { property1 = null, property2 = null }){
    // do stuff
    return something
}

来自文档: Optional parameters和 Documenting a destructuring parameter