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

2019-07-26 09:46:06 +08:00
 legiorange
16931 次点击
所在节点    Java
59 条回复
wenzhoou
2019-07-26 09:48:33 +08:00
人家的家规,开心就好。
shuizhengqi
2019-07-26 09:51:31 +08:00
不规定的话,如果大家都在行首注释,你来一个行尾注释,那你这个注释到底是针对上面的还是下面的?除了你,谁能懂
skiy
2019-07-26 09:55:33 +08:00
难道我看代码得从下面开始看的吗?每个 IDE 编辑器打开时都是头部显示的。注释一目了然,你却还要别人拉到最底部看注释才懂此文件干嘛用的。拉到下面了,我肯定都瞄了一遍代码了。
fan123199
2019-07-26 09:56:42 +08:00
@shuizhengqi 没有行首注释啊。我猜是因为许多人其实是要对一段代码注释,但只注释到了首行行末,这样可能不利于理解。另外 ide 对行末的注释也不会生产文档。 但是,我要说的是,很多时候行末注释是有效提高理解效率,我觉得可以用。
maichael
2019-07-26 09:57:19 +08:00
没什么看法,代码规范这种东西大多数情况下都不是为了分对错,而是为了减少争议。
fan123199
2019-07-26 09:58:02 +08:00
@skiy 是行末,不是文件末。
hand515
2019-07-26 09:58:53 +08:00
格式化有对一行多少个字符规定
chendy
2019-07-26 09:59:33 +08:00
个人观点:因为非文档注释通常都是要说明一些特殊情况,所以最好出现在代码前,先知道要做什么再看到代码
另外行尾注释比较容易超出宽度限制
legiorange
2019-07-26 10:20:17 +08:00
@shuizhengqi 行首注释 意思是这样吗。。?
// base
var base = Base ;
W1angMh
2019-07-26 10:21:42 +08:00
@skiy 兄弟看清是行末注释
W1angMh
2019-07-26 10:24:19 +08:00
@legiorange 是的,某行代码或者某个代码块的注释写在该行的上方(代码块写在第一行的上方)
qwerthhusn
2019-07-26 10:24:49 +08:00
别人的家规,参考一下得了,至少我感觉 这个没必要。

还有阿里的 IDEA 代码检查插件,我感觉啥有用的东西都检查不出来,检查出来的都是一些不关痛痒的东西。。

不过 IDEA 自带的 Inspect Code 是真的流批,只要代码那块黄了,八成是有问题的或者可以优化的
skiy
2019-07-26 10:30:24 +08:00
行尾是指:
legiorange
2019-07-26 10:32:23 +08:00
@skiy String id = params.get("c_Id"); //班级 ID
类似这样。行尾行末是一个意思。
skiy
2019-07-26 10:32:59 +08:00
var abc = 1; // 这种行末注释对吧?

如果这种要求,我觉得没必要了。

有时要定义一堆初始值时,我就是

var abc = 1; // abc 的注释
var bcd = 2; // bcd 的注释



// abc 的注释
var abc = 1;

// bcd 的注释
var bcd = 2;

感觉这样挺影响阅读的
darlinghsu
2019-07-26 10:34:05 +08:00
@skiy #13
大概是

demo() { //这是 xxxxx

}

我的习惯是:

//这是 xxxx
demo() {

}
yanguangs
2019-07-26 10:35:39 +08:00
阿里家规罢了.
oxoxoxox
2019-07-26 10:35:51 +08:00
这和“缩进应该用四个 space、还是两个 space、还是一个 tab ”这种问题有什么区别?
laoyur
2019-07-26 10:36:44 +08:00
@skiy > 行尾是指:

??承认一句看错了很难吗
skiy
2019-07-26 10:38:16 +08:00
@darlinghsu 如果是代码块,我习惯放在前面

// abc 的注释
abc () {

}

但是 if else 功能好难用。。。

// abc
if abc {

// else 这里放置注释,IDEA 不太方便
} else { // 有很多人是放在这里注释,感觉这种情况放在这里注释很方便

}

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

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

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

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

© 2021 V2EX