间隔行注释

强制在行注释中的 // 后使用一致的空格。

某些风格指南要求或禁止在线注释的初始 // 后立即使用空格。// 后面的空格使阅读注释中的文本更容易。另一方面，在无需在 // 后立即放置空格的情况下，注释掉代码更容易。

规则详情

此规则将强制执行行注释 // 开始后空格的一致性。

此规则接受两个参数。如果第一个是 "always"，则 // 后面必须至少有一个空格。如果 "never"，则 // 后面不应有空格。默认值为 "always"。

第二个参数是一个对象，其中包含一个键 "exceptions"。该值是一个字符串模式数组，这些模式被视为规则的例外。需要注意的是，如果第一个参数为 "never"，则忽略这些例外。不能混合使用例外。

此规则的错误代码示例

// When ["never"]
// This is a comment with a whitespace at the beginning
1
2

//When ["always"]
//This is a comment with no whitespace at the beginning
var foo = 5;
1
2
3

// When ["always",{"exceptions":["-","+"]}]
//------++++++++
// Comment block
//------++++++++
1
2
3
4

此规则的正确代码示例

// When ["always"]
// This is a comment with a whitespace at the beginning
var foo = 5;
1
2
3

//When ["never"]
//This is a comment with no whitespace at the beginning
var foo = 5;
1
2
3

// When ["always",{"exceptions":["-"]}]
//--------------
// Comment block
//--------------
1
2
3
4

// When ["always",{"exceptions":["-+"]}]
//-+-+-+-+-+-+-+
// Comment block
//-+-+-+-+-+-+-+
1
2
3
4

此规则在 ESLint v0.9.0 中引入，并在 v1.0.0-rc-1 中移除。

编辑此页面