【代码规范】常见排版规范

1.程序块要采用缩进风格编写,缩进的空格数为4个。

 

2.分界符(如大括号{})应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及iffordowhileswitchcase语句中的程序都要采用如上的缩进方式。

示例:

如下例子不符合规范

for (...) {
  ... // program code
 }

if (...) 
 {
  ... // program code
  }
 
 

void example_fun( void )
  {
  ... // program code
  }

应该如下书写

for  (...) 
 {
     ... // program code
 }
 
 

if  (...) 
 {
     ... // program code
 }
 
 

void  example_fun( void )
 {
     ... // program code
 }

3.较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

示例:

if  (filename != null 
     && new File(logPath +  filename).length() < LogConfig.getFileSize())
 {
     ... // program code
 }

 

4.不允许把多个短语句写在一行中,即一行只写一条

示例:

如下例子不符合规范

LogFilename  now = null;  LogFilename that = null;

应如下书写

LogFilename now = null;
LogFilename that = null;

 

5. if, for, do, while,case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}
示例:

如下例子不符合规范

if(writeToFile)  writeFileThread.interrupt();

应如下书写:

If (writeToFile)

{

    writeFileThread.interrupt();

}

 

6.在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。示例:

(1) 逗号、分号只在后面加空格。

int a, b, c;

(2)比较操作符,赋值操作符"=""+=", 算术操作符"+""%", 逻辑操作符"&&""&",位域操作符"<<""^"等双目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a =  b ^ 2;

(3)"!""~""++""--""&"( 地址运算符)等单目操作符前后不加空格。

flag = !isEmpty; // 非操作"!"与内容之间

i++; // "++","--"与内容之间

(4)"."前后不加空格。

p.id = pid; // "."前后不加空格

(5)ifforwhileswitch等与后面的括号间应加空格,使if等关键字更为突出、明显。

if (a >= b && c > d)



 

7.类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。

格式:

{

类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
类的保护方法定义
类的私有方法定义

}

 


猜你喜欢

转载自blog.csdn.net/weixin_42488570/article/details/80823914