如何记录具有已知参数类型的可变长度的参数列表？

Question

相关：在 JSDoc 中记录开放式参数函数的正确方法

我有一个通过访问 < 来接受多个数组的函数code>arguments 变量：

/**
 * @param options An object containing options
 * @param [options.bind] blablabla (optional)
 */
function modify_function (options) {
    for (var i=1; i<arguments.length; i++) {
        // ...
    }
}

现在，我知道除了 options 之外的每个参数都是一个包含值得记录的值的数组：

[search_term, replacement, options]

我不考虑将（冗长的）描述放在变量参数中 线。

@param {...} 包含搜索词、替换词及其选项的数组；索引 0：函数内的搜索项； 1：替换文字； 2：可选选项（catch_errors：捕获错误并记录它，escape：在替换文本中转义美元，pos：“L”用于将替换放在搜索词之前，“R”用于将其放置在搜索词之后） 不是一个可读的解决方案，并且类型不可见。

有没有办法记录变量参数的类型和值？

@param {...[]} An array with search terms, replacements and its options
@param {...[0]} The search term within the function
@param {...[1]} The replacement text 
@param {...[2]} An optional object with obtions for the replacement
@param {...[2].catch_errors} catches errors and log it
@param {...[2].escape} etc...

上面看起来很难看，但它应该让您了解我想要实现的目标：

• 记录变量参数的类型（在本例中是数组）
• 记录该数组的值
• 记录该数组内对象的属性

为了懒惰，我使用了数组而不是对象。随时欢迎其他建议。

Answer 1

您的函数并不是真正的可变参数，您应该将其签名更改为foundrama 建议的内容。除了 JSDoc 的语法比 Foundrama 建议的好一点之外

/**
 * @param {String} searchTerm
 * @param {String} replacementText
 * @param {Object} opts (optional) An object containing the replacement options
 * @param {Function} opts.catch_errors Description text
 * @param {Event} opts.catch_errors.e The name of the first parameter 
 *         passed to catch_errors
 * @param {Type} opts.escape Description of options
 */

，你可以这样称呼它：

modify_text('search', 'replacement', {
    catch_errors: function(e) {

    },
    escape: 'someEscape'

});

如果你确实有 varargs 风格的情况，它应该是一个相同类型的变量，可以在参数列表的末尾传递，我将其记录如下，虽然它不是 JSDoc 标准，但它是 Google 在其文档中使用的标准

/**
 * Sums its parameters
 * @param {...number} var_args Numbers to be added together
 * @return number
 */
function sum(/* num, num, ... */) { 
    var sum = 0;
    for (var i =0; i < arguments.length; i++) {
      sum += arguments[i];
    }
    return sum;
}

Answer 2

除非您受到其他 API 的限制，否则我建议的第一件事是：除了您打算迭代的数据集合之外，不要使用数组。

可能是这里最好的方法将重构该函数，使其采用三个参数或某种参数对象。例如：

/**
 * @param {String} searchTerm
 * @param {String} replacementText
 * @param {Object} replacementOpts (optional) An object containing the replacement
 * options; optional values in the object include:<ul>
   <li>catch_errors {Type} description text...</li>
   <li>escape {Type} description text...</li></ul>
 */

我强烈建议不要使用数组（再次强调：“除非您受到某些超出您控制范围的 API 的限制），因为它会变得脆弱并且最终会有点令人困惑。