如何使用已知参数类型记录长度可变的参数列表?
|
相关:在JSDoc中记录开放式参数函数的正确方法
我有一个通过访问
arguments
变量来接受多个数组的函数:
/**
* @param options An object containing options
* @param [options.bind] blablabla (optional)
*/
function modify_function (options) {
for (var i=1; i<arguments.length; i++) {
// ...
}
}
现在,我知道除ѭ2之外的每个参数都是一个数组,其中包含值得记录的值:
[search_term, replacement, options]
我不考虑将(冗长的)描述放在可变参数行中。
@param {...}包含搜索项,替换项及其选项的数组;索引0:函数内的搜索词; 1:替换文字; 2:可选选项(catch_errors:捕获错误并将其记录,转义:在替换文本中转义美元,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...
上面的代码看起来很丑陋,但是应该可以让您大致了解我要实现的目标:
记录变量参数的类型(在这种情况下为数组)
记录此数组的值
记录此数组内对象的属性
为了懒惰,我使用了数组而不是对象。总是欢迎其他建议。
没有找到相关结果
已邀请:
2 个回复
葛瞎说漓
你会这样称呼它
如果确实有varargs样式的情况,则它应该是可以在参数列表末尾传递的相同类型的变量,我将其记录如下,尽管它不是JSDoc标准,但是\就是Google在其文档中使用的
席酱
我强烈建议您不要使用该数组(再次:“除非您受到控件外部的某些API的约束”),否则它会变得很脆弱,最终会造成一些混乱。