为何阿里规约在 Java 中不能行尾注释?你们有什么看法?

2019-07-26 09:46:06 +08:00
 legiorange
17270 次点击
所在节点    Java
59 条回复
mikulch
2019-07-26 15:01:05 +08:00
国际上都是首行注释。
Aresxue
2019-07-26 15:06:20 +08:00
看着行数多。。。逃
javaWeber
2019-07-26 15:07:02 +08:00
alt+Enter。再点击那个 no inspect,就可以取消这个检查了。
viator42
2019-07-26 15:10:02 +08:00
行尾没什么不好的,定义变量的时候很清楚
现在显示屏的分辨率都很高,超宽应该早就不是什么问题了
nekoneko
2019-07-26 15:23:13 +08:00
习惯这样
/* 注释 **/
private static fianl Xxxx XXXXXX = XXXXX;

// 注释
int a = 0;


// 注释
if(){


}
//注释
else{

}
metrxqin
2019-07-26 15:29:46 +08:00
我挺爱在行尾注释,但是我的同事 IDE 有阿里规约插件,每次提交内容好多变动都是纠正这个问题。
MotherShip
2019-07-26 16:31:12 +08:00
就应该禁掉行尾注释

对不齐的行尾注释看着难受,对齐的。。改完代码还得对齐一次

何况我没有带鱼屏
real3cho
2019-07-26 16:37:00 +08:00
你怎么不戴帽子呢
rizon
2019-07-26 17:09:14 +08:00
禁止行尾注释有个不好的地方就是比如一个 if 语句,你想对 if 的条件做注释,那么这个注释是针对 if 条件的呢还是针对整个 if 块的呢,这时候就很难受,唉~

不过行尾注释的危害其实更大,比如不够显眼,要往左侧拉滚动条
cco
2019-07-26 17:17:42 +08:00
怎么都可以,好看就行,能一屏装得下就行。
dr2009
2019-07-26 17:52:34 +08:00
一些变量的定义放行尾看着也挺舒服的
kuroismith
2019-07-26 17:57:17 +08:00
行首注释还是行尾注释其实并不重要
但是如果没有这个规定, code review 的时候就会像这楼里一样为了这种屁事吵来吵去
kuroismith
2019-07-26 17:59:07 +08:00
@opengps 编译器分得清代码审核工具会分不清吗? 除非是审查工具蠢到直接用简单的正则来匹配.
murmur
2019-07-26 18:00:21 +08:00
把这行注释掉就可以 反正现在都是大屏幕 我们一行的代码已经设置到 250-300 个字符了
tslling
2019-07-26 18:33:02 +08:00
规矩没什么好说的。要说原因的话可能是行尾注释比换行注释更容易被忽略。再就是对 diff 友好一点,比如修改了注释的时候不换行还要仔细对比,换行注释的话 diff 结果更明了。注释和代码本来是两个不同的东西,我觉得换行注释更合理一点,如果公司规定了一定要换行那肯定要遵守,但是应该没有规定一定不能换行的公司吧。。。
jason19659
2019-07-26 21:57:27 +08:00
[强制] 方法内部单行注释,在被注释语句上方另起一行,使用 //注释。方法内部多行注释 使用 /* */注释,注意与代码对齐。
[强制] 类、类属性、类方法的注释必须使用 Javadoc 规范,使用 /**内容*/格式,不得使用 // xxx 方式。
weakish
2019-07-26 22:46:22 +08:00
以下纯属虚构,如有雷同,纯属巧合。

1. 行尾注释一般是针对某一行代码的。这种针对某一行代码的注释很多情况下是没有必要的,剩下的一些情况,不如把代码换一种更明白清晰的写法。真正需要注释某一行代码的情景是很少的。比如 Python 的 PEP 8 也推荐「 Use inline comments sparingly.」
2. 因为 1,很多项目的代码中极少出现行尾注释。
3. 某个人或者某群人编写代码风格规范的时候因为 2 的缘故,所以加上了不准行尾注释这条,但是出发点可能只是因为很少看到行尾注释,所以看到行尾注释感觉不顺眼,并不清楚 1 的原因。因此搞了一刀切,一律不准(很可能也有一刀切方便贯彻的因素)。
cyspy
2019-07-27 15:06:13 +08:00
写 RDD、Stream 和 builder 的时候用行尾注释很自然
jaylee4869
2019-08-05 14:40:31 +08:00
考虑代码+注释在屏幕上的长度。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/586307

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX