javascript - 单行注释应该放在行尾还是代码上方呢？

Question

如果有必要添加单行注释，大家开发一般把 单行注释 放在代码行尾，还是独占一行放在代码的上方呢？还是具体情况，具体分析？是个人习惯，还是有着你的理由。希望大家讨论，我好学习学习。

• 行尾

var var1 = 5; // 声明并初始化变量，值为5

• 上方

// 声明并初始化变量，值为5
var var1 = 5; 

Answer 1

1、简短代码块声明放在上方
2、注释过长就使用多行注释，并放在上方
所以说，个人习惯

Answer 2

我习惯写上面

Answer 3

写上面比较好 可以与上一行代码隔离开 能够清晰一些

Answer 4

可以试试jsDoc规则
http://usejsdoc.org/
jsdoc明确规定了，注释块注释放上面，单行注释放右侧。
除了公司规定就照这个经念就可以

Answer 5

这个具体看公司代码规范了，如果没有代码规范明确限制，自己写注释最好放在上面，不然你一会儿代码上面一个注释，一会代码右边一个注释，自己看的时候就觉得乱了

Answer 6

个人习惯放在上面。
ps:注释用来说明代码的功能块或者不太容易理解的模块。不要随便写注释

Answer 7

至于单行注释写在上面好还是写在下面好，都没关系，我一般注释都是这样：

// XXX功能 start
...
do {
    xxxxx...
} while(x...);
...
// XXX功能 end

Answer 8

说实在虽然放后面比较好看注释，但用起来有时候很纠结，特别是如果想在数组元素后面加注释的时候，在加了注释之后，发现要加一个新元素的时候，需要再去添加,。

栗子：

$test = [
    a, //a
    b  //b，如果需要在后面添加一个元素，需要补上,号，虽然可以在最后元素加上,不报错，但是对于强迫症来讲，不喜欢多余的,号
]

Answer 9

如果是一个功能的话会在上面，单独注释一行代码的话会在尾部更随。

Answer 10

注释只是为了增加代码的可阅读性 并且 一般来说 短行代码 在右侧注释比较友好 而长行代码 在头部或下行注释 便于看清不乱