# spaced-line-comment
在行注释中强制在 //
之后保持一致的间距。
(已删除)此规则在 ESLint v1.0 中已删除,并由 spaced-comment
规则替换。
一些样式指南要求或不允许在行注释的初始 //
之后立即使用空格。//
之后的空格使阅读评论中的文本更容易。另一方面,注释掉代码更容易,无需在 //
之后放置空格。
# 规则详情
此规则将强制行注释 //
开始后的间距保持一致。
这条规则有两个参数。如果第一个是 "always"
,那么 //
后面必须至少跟一个空格。如果 "never"
那么后面应该没有空格。默认值为 "always"
。
第二个参数是一个带有一个键 "exceptions"
的对象。该值是一个字符串模式数组,被视为规则的例外。需要注意的是,如果第一个参数是 "never"
,则忽略异常。例外不能混用。
此规则的错误代码示例:
// When ["never"]
// This is a comment with a whitespace at the beginning
//When ["always"]
//This is a comment with no whitespace at the beginning
var foo = 5;
// When ["always",{"exceptions":["-","+"]}]
//------++++++++
// Comment block
//------++++++++
此规则的正确代码示例:
// When ["always"]
// This is a comment with a whitespace at the beginning
var foo = 5;
//When ["never"]
//This is a comment with no whitespace at the beginning
var foo = 5;
// When ["always",{"exceptions":["-"]}]
//--------------
// Comment block
//--------------
// When ["always",{"exceptions":["-+"]}]
//-+-+-+-+-+-+-+
// Comment block
//-+-+-+-+-+-+-+