Checkstyle:单行Java注释应该在开头的两个斜杠后留一个空格吗?

Checkstyle:单行Java注释应该在开头的两个斜杠后留一个空格吗?,java,comments,checkstyle,Java,Comments,Checkstyle,似乎没有a或a可确保单行注释的格式如下: // comment text 但事实并非如此: //comment text 《公约》第3.7节“评论”暗示了本公约: 3.7。评论 有两种评论: /* text */ A traditional comment: all the text from the ASCII characters /* to the ASCII characters */ is ignored (as in C and C++). // text An end-o

似乎没有a或a可确保单行注释的格式如下:

// comment text
但事实并非如此:

//comment text
《公约》第3.7节“评论”暗示了本公约:

3.7。评论

有两种评论:

/* text */

A traditional comment: all the text from the ASCII characters /* to the ASCII characters */ is ignored (as in C and C++).

// text

An end-of-line comment: all the text from the ASCII characters // to the end of the line is ignored (as in C++).
概括地说,它在Java本身似乎是一种习惯,例如

这是一贯的,因此显然是故意的

因此,省略两个斜杠和注释文本之间的空格是否客观上是错误的


是否有一个著名的Checkstyle checks扩展库包含对此的检查

JLS中没有约定,甚至没有默示约定。JLS不指导您如何格式化代码,它是一种语言规范。即使在JLS中,他们也会打开
{
在新的一行中,这并不意味着任何人都暗示每个人都应该这样做。Checkstyle的github:和@M.Prokhorov上的相关开放问题感谢您对这一点的意见。但是,JLS中给出的代码片段和JDK中的代码注释有一个毫不动摇的一致性,以两个斜杠加一个空格将约定(名词)定义为“一种通常做某事的方式”(来源:谷歌“定义约定”)我认为我将其称为约定是正确的。省略空格是合法的,但这样做似乎不合常规,基于此,我很惊讶没有对其进行检查(对类似的事情也有检查,这些检查也是合法的,但不符合常规)。我的观点是JLS中没有约定。OpenJDK和其他一些地方可能有约定。但对注释进行任何特定格式设置显然不是客观上正确或不正确的。至于检查,您的链接正好提供了它不存在的原因(目前)-没有人关心添加一个。问题是“客观上是否不正确”的答案肯定是“不”",因为无论哪种风格都有一个客观的答案;如果这个答案不令人满意,那么这个问题就是一个意见问题。不管它值多少钱,我想说,如果你想在一行代码前面加上
/
,需要一个空格对你来说是不好的;空格只会浪费额外的按键时间。在这种情况下在这种情况下,注释的意思是在不从源代码中删除代码的情况下停止代码的执行,而不是为了解释程序如何工作而需要可读的东西。