养成良好的写代码习惯-CFANZ编程社区

本文将介绍一些写代码时容易被忽略的点

一.空行

1.在每个类声明之后、每个函数定义结束之后都要加空行。

// 空行 
void Function1(…)
 { 
     …
 } 
// 空行 
void Function2(…)
 {
     … 
 } 
// 空行 
void Function3(…)
 { 
     … 
 } 
//空行

2.在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

//空行
while (condition)
{
    statement1;
    // 空行 
    if (condition)
    {
        statement2;
    }
    else
    {
        statement3;
    }
    // 空行 
    statement4;
}

二.代码行

1.一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。

int width; // 宽度 
int height; // 高度 
int depth; // 深度 
x = a + b;
y = c + d;
z = e + f;

//上面的代码与下面的代码对比
//明显上面的代码会顺眼许多

int width, height, depth; // 宽度高度深度
x ＝ a + b; y = c + d; z = e + f;

2.if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

//前者
if (width < height) 
{ 
	dosomething();
}

for (initialization; condition; update) 
{
	dosomething();
} 
// 空行 
	other();

//后者

if (width < height) dosomething(); 

for (initialization; condition; update) 
	dosomething();
other();

三.代码行内的空格

1.关键字之后要留空格。像const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。

2.函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。

3.‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。

4.赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

5.一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。

6.像“［］”、“.”、“->”这类操作符前后不加空格。

7.对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d)) 。

void Func1(int x, int y, int z); // 良好的风格 
void Func1 (int x,int y,int z); // 不良的风格 
if (year >= 2000) // 良好的风格 
if(year>=2000) // 不良的风格 
if ((a>=b) d)) // 良好的风格
if(a>=bd) // 不良的风格 
for (i=0; i<10; i++) // 良好的风格
for(i=0;i<10;i++) // 不良的风格
for (i = 0; I < 10; i ++) // 过多的空格 
x = a < b ? a : b; // 良好的风格 
x=a<b?a:b; // 不好的风格 
int *x =  // 良好的风格 
int * x =  // 不良的风格 
array[5] = 0; // 不要写成 array [ 5 ] = 0;
a.Function(); // 不要写成 a . Function();
b->Function(); // 不要写成 b -> Function();

四.对齐

1.程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。

void Function(int x)
{
	… // program code 
}

//第一种要比第二种好看的多

void Function(int x) {
	… // program code 

}

五.长行拆分

代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

if ((very_longer_variable1 >= very_longer_variable12) 
	&& (very_longer_variable3 <= very_longer_variable14) 
	&& (very_longer_variable5 <= very_longer_variable16))
{
	dosomething();
}

virtual CMatrix CMultiplyMatrix(CMatrix leftMatrix, 
								CMatrix rightMatrix);

for (very_longer_initialization; 
	 very_longer_condition; 
	 very_longer_update)
{
	dosomething(); 
}

六.修饰符的位置

应当将修饰符 * 和＆紧靠变量名

char *name;
int *x,y;//此处y不会被误解为指针

虽然很多编译器能够帮我们做这个工作，但仍然不能偷懒，要养成习惯，对自己对别人都好！