javascript - 在 JSDoc 中记录开放式参数函数的正确方法

Question

假设您有如下内容:

var someFunc = function() {
    // do something here with arguments
}

您如何在 JSDoc 中正确记录此函数可以采用任意数量的参数？这是我最好的猜测，但我不确定它是否正确。

/**
 * @param {Mixed} [...] Unlimited amount of optional parameters
 */
var someFunc = function() {
    // do something here with arguments
}

相关:php - How to doc a variable number of parameters

Answer 1

JSDoc specs和 Google's Closure Compiler这样做:

@param {...number} var_args

其中“number”是预期的参数类型。

完整的用法如下所示:

/**
* @param {...*} var_args
*/
function lookMaImVariadic(var_args) {
    // Utilize the `arguments` object here, not `var_args`.
}

请注意有关使用 arguments(或 arguments 的一些偏移量)访问您的附加参数的注释。 var_args 它只是用来向您的 IDE 发出参数确实存在的信号。

Rest parameters in ES6可以将实际参数进一步包含提供的值(因此不再需要使用 arguments):

/**
* @param {...*} var_args
*/
function lookMaImES6Variadic(...var_args) {
    // Utilize the `var_args` array here, not `arguments`.
}