max-params

Enforce a maximum number of parameters in function definitions

有众多参数的函数可能会难以阅读和编写，因为它需要记住每个参数的内容、类型、顺序。因此，许多程序员坚持一个惯例，即限制单一函数可接收参数数量的上限。

function foo (bar, baz, qux, qxx) { // 四个参数可能太多了点
    doSomething();
}
1
2
3

规则细节

这条规则强制规定了函数定义中允许的最大参数数。

选项

这个规则有一个数字或对象选项：

• "max"（默认为 3）在函数定义中执行最大的参数数

废弃：对象属性 maximum 已废弃，请使用对象属性 max 代替。

max

使用此规则与默认的 { "max": 3 } 选项的错误示例：

/*eslint max-params: ["error", 3]*/
/*eslint-env es6*/

function foo (bar, baz, qux, qxx) {
    doSomething();
}

let foo = (bar, baz, qux, qxx) => {
    doSomething();
};
1
2
3
4
5
6
7
8
9
10

使用此规则与默认的 { "max": 3 } 选项的正确示例：

/*eslint max-params: ["error", 3]*/
/*eslint-env es6*/

function foo (bar, baz, qux) {
    doSomething();
}

let foo = (bar, baz, qux) => {
    doSomething();
};
1
2
3
4
5
6
7
8
9
10

Related Rules

• complexity
• max-depth
• max-len
• max-lines
• max-lines-per-function
• max-nested-callbacks
• max-statements

Version

This rule was introduced in ESLint v0.0.9.

Resources

• Rule source
• Tests source