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

发布于 2022-09-07 12:32:09 字数 410 浏览 21 评论 0

/**
 * 这个函数用来示范一般函数参数注释方式!
 * @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注释时应该怎么写呢??

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

放我走吧 2022-09-14 12:32:09
/**
 * @param {Object} option - foo
 * @param {String} option.name - bar
 * @param {Number} option.age - baz
 */
function bar({name,age}) {
    return {name, age}
}
尴尬癌患者 2022-09-14 12:32:09

JSDOC 找到 Documenting a destructuring parameter

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文