如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。
行尾
var var1 = 5; // 声明并初始化变量,值为5
上方
// 声明并初始化变量,值为5 var var1 = 5;
看到有人提到jsdoc,个人也是使用jsdoc的,提供一个jsdoc 中文版文档。关于注释,个人感觉行注释写行位,块注释写行首。
jsdoc
不同语言注释规范也不一样,python就用#或者"""""",最好跟规范走
如果使用formater之类的,单行注释放后边;不然,有些格式化工具格式化出来的东西略诡异;
说实在虽然放后面比较好看注释,但用起来有时候很纠结,特别是如果想在数组元素后面加注释的时候,在加了注释之后,发现要加一个新元素的时候,需要再去添加,。
,
栗子:
$test = [ a, //a b //b,如果需要在后面添加一个元素,需要补上,号,虽然可以在最后元素加上,不报错,但是对于强迫症来讲,不喜欢多余的,号 ]
看注释长度。。。
一般情况下,个人的习惯是:1、变量声明或初始化,放在右方2、简短代码块声明放在上方3、注释过长使用多行注释,并放在上方
注释只是为了增加代码的可阅读性 并且 一般来说 短行代码 在右侧注释比较友好 而长行代码 在头部或下行注释 便于看清不乱
如果是一个功能的话会在上面,单独注释一行代码的话会在尾部更随。
习惯......
注释写上面吧。一般来说格式化的注释,然后可以导出API。
然后就是为了让你自己看的注释,你就随便写吧。反正除了你也没人会看你的注释。文档的注释一般都在头部。随便写的注释感觉没什么用