Jsdoc 函数有解构参数时如何注释呢

maple
  • 6
/**
 * 这个函数用来示范一般函数参数注释方式!
 * @param {String} unit
 * @param {Number} item
 */
function foo(name,age) {
    return {name, age}
}

foo("Luke",18)

/**
 * 这个函数的注释写法是什么呢?
 * @param {String} ??? 此时应该如何注释呢
 * @param {Number} ??? 此时应该如何注释呢
 */
function bar({name,age}) {
    return {name, age}
}

bar({
  age: 18
  name: "Luke"
})

第二个函数这样写可以不用刻意安排参数的输入顺序,但是如果我想用JsDoc注释时应该怎么写呢??

回复
阅读 5.8k
2 个回答
✓ 已被采纳
/**
 * @param {Object} option - foo
 * @param {String} option.name - bar
 * @param {Number} option.age - baz
 */
function bar({name,age}) {
    return {name, age}
}

JSDOC 找到 Documenting a destructuring parameter

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
宣传栏