如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。
行尾
var var1 = 5; // 声明并初始化变量,值为5
上方
// 声明并初始化变量,值为5
var var1 = 5;
如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。
行尾
var var1 = 5; // 声明并初始化变量,值为5
上方
// 声明并初始化变量,值为5
var var1 = 5;
注释写上面吧。一般来说格式化的注释,然后可以导出API。
然后就是为了让你自己看的注释,你就随便写吧。反正除了你也没人会看你的注释。文档的注释一般都在头部。随便写的注释感觉没什么用
注释格式:
1、单行(single-line)注释://……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
4、javadoc 注释标签语法
从个人的项目经验来看,情况如下使用比较整洁:
1、变量一般用单行注解,放在行尾,若变量或注解太长,也可放上方,若注解太长,就改用块注释,根据情况而定;
SAXReader reader = new SAXReader();//创建SAXReader
//获取<List>根标签下的所有emp标签
List<Element>elements = root.elements();
/*
* Element提供了获取中间文本信息的方法:
* String getText()
* String getTextTrim()
*/
String name = nameEle.getText();
2、调用方法一般用块注解,放在上方;
/* 读取XML文件 */
Document doc = xmlFileReader();
个人认为 关于注释 要有三个优先级: 项目要求规范为最高级,如果项目没有要求,那就按照官方标准,如果没有官方标准,那就按自己的标准。。 对于自己的标准,引用上面一个回答说的:“不要为了注释而注释”,注释的目的是让复杂的代码清晰易懂
至于单行注释写在上面好还是写在下面好,都没关系,我一般注释都是这样:
// XXX功能 start
...
do {
xxxxx...
} while(x...);
...
// XXX功能 end
说实在虽然放后面比较好看注释,但用起来有时候很纠结,特别是如果想在数组元素后面加注释的时候,在加了注释之后,发现要加一个新元素的时候,需要再去添加,
。
栗子:
$test = [
a, //a
b //b,如果需要在后面添加一个元素,需要补上,号,虽然可以在最后元素加上,不报错,但是对于强迫症来讲,不喜欢多余的,号
]
8 回答4.8k 阅读✓ 已解决
3 回答2.6k 阅读✓ 已解决
6 回答3.5k 阅读✓ 已解决
3 回答4.1k 阅读✓ 已解决
5 回答2.9k 阅读✓ 已解决
5 回答6.4k 阅读✓ 已解决
3 回答3.1k 阅读✓ 已解决
一般情况下,个人的习惯是:
1、变量声明或初始化,放在右方
2、简短代码块声明放在上方
3、注释过长使用多行注释,并放在上方
重点是,不要为了注释而注释,变量、函数等命名规范了,代码能清晰看懂就尽量往这个方向努力。毕竟有 “代码之美”,而未曾听说有 “注释之美”。