Heim > Fragen und Antworten > Hauptteil
如果有必要添加单行注释,大家开发一般把 单行注释 放在代码行尾,还是独占一行放在代码的上方呢?还是具体情况,具体分析?是个人习惯,还是有着你的理由。希望大家讨论,我好学习学习。
行尾
var var1 = 5; // 声明并初始化变量,值为5
上方
// 声明并初始化变量,值为5
var var1 = 5;
黄舟2017-04-11 09:50:55
一般情况下,个人的习惯是:
1、变量声明或初始化,放在右方
2、简短代码块声明放在上方
3、注释过长使用多行注释,并放在上方
阿神2017-04-11 09:50:55
注释写上面吧。一般来说格式化的注释,然后可以导出API。
然后就是为了让你自己看的注释,你就随便写吧。反正除了你也没人会看你的注释。文档的注释一般都在头部。随便写的注释感觉没什么用
天蓬老师2017-04-11 09:50:55
注释格式:
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();
黄舟2017-04-11 09:50:55
个人习惯吧!
我一般代码太长的,或者需要注释的文字太多的,会放在代码上访,单独一行或者几行。
简短的,类似你这种,就放在代码后面。
甚至习惯性的会输入空的://
。
PHP中文网2017-04-11 09:50:55
个人认为 关于注释 要有三个优先级: 项目要求规范为最高级,如果项目没有要求,那就按照官方标准,如果没有官方标准,那就按自己的标准。。 对于自己的标准,引用上面一个回答说的:“不要为了注释而注释”,注释的目的是让复杂的代码清晰易懂