如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。
行尾
var var1 = 5; // 声明并初始化变量,值为5
上方
// 声明并初始化变量,值为5 var var1 = 5;
个人习惯放在上面。ps:注释用来说明代码的功能块或者不太容易理解的模块。不要随便写注释
我习惯写上面
看个人习惯,放后边更好点
个人习惯 都在上面 ,单行注释右边的话,可能会造成需要拖动滚动条才能看到后面的
个人习惯吧!
我一般代码太长的,或者需要注释的文字太多的,会放在代码上访,单独一行或者几行。
简短的,类似你这种,就放在代码后面。
甚至习惯性的会输入空的://。
//
看个人习惯或者团队习惯。
可以试试jsDoc规则http://usejsdoc.org/jsdoc明确规定了,注释块注释放上面,单行注释放右侧。除了公司规定就照这个经念就可以
这个具体看公司代码规范了,如果没有代码规范明确限制,自己写注释最好放在上面,不然你一会儿代码上面一个注释,一会代码右边一个注释,自己看的时候就觉得乱了
个人认为 关于注释 要有三个优先级: 项目要求规范为最高级,如果项目没有要求,那就按照官方标准,如果没有官方标准,那就按自己的标准。。 对于自己的标准,引用上面一个回答说的:“不要为了注释而注释”,注释的目的是让复杂的代码清晰易懂
至于单行注释写在上面好还是写在下面好,都没关系,我一般注释都是这样:
// XXX功能 start ... do { xxxxx... } while(x...); ... // XXX功能 end