【问题标题】:Using @param for an object that is being passed through a function对通过函数传递的对象使用@param
【发布时间】:2021-06-15 08:41:00
【问题描述】:

基本上,我需要做的是将@param 用于传递给函数的对象。

/** @param {String} b */
function Hello(a, { b, c }) {


}

我认为它会像这样工作,但事实并非如此。

如何在 b 和 c 上使用 @param?

【问题讨论】:

  • “使用@param”是什么意思?
  • 我刚刚编辑了帖子!
  • JSDoc 是我缺少的上下文:)。我也很好奇答案;不确定 JSDoc 是否可以处理这样的解构对象。
  • 是的!我一直在努力找出如何做到这一点,谢谢!

标签: javascript parameters jsdoc


【解决方案1】:

所以我想通了!

/**
 * @param {object} param0
 * @param {Number} param0.a
*/

async function hello({ a }) {

}

https://jsdoc.app/tags-param.html

您也可以在此处阅读文档!

【讨论】:

    猜你喜欢
    • 2012-02-03
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2017-03-26
    • 2021-07-30
    • 2020-08-11
    • 1970-01-01
    相关资源
    最近更新 更多