为以另一个函数作为参数的函数制作 JSDoc 注释

Question

想象一个接受“onUpdate”函数作为参数的函数：

 /**
 * @param {function} onUpdate
 * @returns {null}
 */
static async init(onUpdate) {
    ...
    onUpdate(true);
};

onUpdate 采用布尔值作为参数。 我想将这些参数添加到

@param {function} onUpdate

。

有办法吗？

一些出色的开发人员设法在这些 addEventListener 函数上做到了这一点：

Answer 1

我认为在屏幕截图中您会看到打字稿提示。但你可以做类似this:

的事情

/**
 * This callback is displayed as a global member.
 * @callback someCallback
 * @param {number} param1
 * @param {number} param2
 * @returns {number}
 */

/**
 * 
 * @param {someCallback} cb 
 */

function someFunction(cb) {

}

看到这个

Answer 2

如果您提前知道类型，则可以在内联定义中对其进行解构，从而允许在回调中输入更复杂的参数，例如数组、对象等。

/**
 * @callback myCallback
 * @param { { param1: number, param2: string } } - Some human friendly explanation
 *
 *
 * @returns {void}
 */

/**
 *
 * @param {myCallback} cb - The function does some cool stuff
 * @param {string} somethingElse - can still define more params for fn
 * @param {number} anotherThng - the same way as before
 *
 *
 * @returns { void } - can be any return you want to type out
 */