一.排版
1.代码缩进
代码块要采用缩进的风格进行编写，缩进的个数为4个。
2.长句分割
较长的语句、表达式或者参数要分成多行进行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首：
//old
if(condition1 && condition2 && condition3){
}
//new
if(condition1
&& condition2
&& condition3){
}
3.空行分割
相对独立的程序块、变量、函数之间必须加空行。有关联的代码紧凑在一起，相对无关的代码需要一个空行分离。
4.数据与函数的排布
类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。
class{
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义
}
二.注释
1.类注释
类和接口的注释放在class或者interface关键字之前，import关键字之后。注释主要是一句话概括功能。类的注释使用如下：
/**
* 一句话功能简述
*/
2.函数的注释
共有和保护方法注释需要列出方法的一句话简述、输入参数、输出参数、返回值等。
/**
*功能简述
*@param 参数1：参数1说明
*@param 参数2：参数2说明
* return 返回值
*/
网友评论