对正在通过 function 的 object 使用 @param

Question

Basically, what I need to do is use @param for an object that is being passed through to a function.

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


}

I thought it would work something like this, but it doesn't.

How would I use @param on b, and c?

Answer 1

So I've figured it out!

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

async function hello({ a }) {

}

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

You can read the documentation here as well!