# max-lines

强制每个文件的最大行数

有些人认为大文件是代码异味。大文件往往会做很多事情,并且很难跟踪正在发生的事情。虽然文件中没有被认为可接受的客观最大行数,但大多数人会同意它不应该是数千行。建议通常在 100 到 500 行之间。

# 规则详情

此规则强制每个文件的最大行数,以帮助可维护性并降低复杂性。

请注意,如果文件以换行符结尾,大多数编辑器会在末尾显示一个额外的空行。此规则不计算该额外行。

# 选项

此规则有一个数字或对象选项:

  • "max"(默认 300)强制文件中的最大行数

  • "skipBlankLines": true 忽略纯粹由空格组成的行。

  • "skipComments": true 忽略仅包含注释的行

# max

此规则的错误代码示例,最大值为 2

/*eslint max-lines: ["error", 2]*/
var a,
    b,
    c;
/*eslint max-lines: ["error", 2]*/

var a,
    b,c;
/*eslint max-lines: ["error", 2]*/
// a comment
var a,
    b,c;

此规则的正确代码示例,最大值为 2

/*eslint max-lines: ["error", 2]*/
var a,
    b, c;
/*eslint max-lines: ["error", 2]*/

var a, b, c;
/*eslint max-lines: ["error", 2]*/
// a comment
var a, b, c;

# skipBlankLines

此规则使用 { "skipBlankLines": true } 选项的错误代码示例:

/*eslint max-lines: ["error", {"max": 2, "skipBlankLines": true}]*/

var a,
    b,
    c;

此规则使用 { "skipBlankLines": true } 选项的正确代码示例:

/*eslint max-lines: ["error", {"max": 2, "skipBlankLines": true}]*/

var a,
    b, c;

# skipComments

此规则使用 { "skipComments": true } 选项的错误代码示例:

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
    b,
    c;

此规则使用 { "skipComments": true } 选项的正确代码示例:

/*eslint max-lines: ["error", {"max": 2, "skipComments": true}]*/
// a comment
var a,
    b, c;

# 何时不使用

如果您不关心文件中的行数,可以关闭此规则。

# 兼容性

  • JSCSmaximumNumberOfLines
Last Updated: 5/13/2023, 8:55:38 PM