目录
【前言】程序的版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。
一. 加上必要的空行
空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序会多消耗一些纸张,但是值得。所以不要舍不得空行。
在每个类声明之后、每个函数定义结束之都要加空行。
在一个函数体内,逻辑上密切相关的语句之间不加空行,其他适当补加空行。
//空行
void Function1()
{
...;
}
//空行
void Function2()
{
...;
}
//空行
void Function3()
{
...;
}
二. 注意代码行(避免代码段太乱)
一行代码只做一件事,如定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于注释和调试。
if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少要加{}。这样可以防止书写失误。
int width; //宽度
int height; //高度
int depth; //深度
x = a + b;
y = c + d;
z = e + f;
if(width < height)
{
dosomething();
}
for(initialization; condition; update)
{
dosomething();
}
//空行
other();
一行代码只做一件事,如定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于注释和调试。
if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少要加{}。这样可以防止书写失误。
int width; //宽度
int height; //高度
int depth; //深度
x = a + b;
y = c + d;
z = e + f;
if(width < height)
{
dosomething();
}
for(initialization; condition; update)
{
dosomething();
}
//空行
other();
尽可能在定义变量的同时初始化该变量(就近原则),如果变量的引用处和其定义处相隔较远,变量的初始化很容易忘记。
如果引用了未被初始化的变量,可能会导致程序错误,所以建议减少隐患。例如:
int width = 10; //定义并初始化width
int height = 10; //定义并初始化height
int depth = 10; //定义并初始化depth
三. 注意使用空格
在我们写代码中,其实空格可以使我们写出的代码可读性更高。
关键字之后要留空格。像const、case、int、float等关键字之后至少要留一个空格,否则无法辨别关键字。
像if、for、while等关键字之后应留一个空格再跟左括号'(' , 以突出关键字。
函数名之后不要留空格,紧跟'左括号'(' ,以与关键字区分。
‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如for(initialization; condition; update)。
赋值操作符、比较操作符、算数操作符、逻辑操作符、位移操作符,如“=”、“>=”、“<=”、“&&”、“^”等二元操作符的前后应当加上空格。
像“[]”、“.”、“、”、“->”这类操作符前后不加空格。
对于表达式比较长的for语句和if语句,为了紧凑起见可以适当去掉一些空格,如for(i=0; i<10; i++)和if((a<=b)&&(c<=d))。
一些良好的代码风格:
void Func1(int x, int y, int z);
if(year >= 2000)
if((a>=b)&&(c<=d))
for(i=0; i<10; i++)
x = a < b ? a : b;
int *x = &y;
arr[5] = { 0 };
a.Function();
b->Function();
四. 开头对齐
程序的分解符‘{’ 和 ‘}’ 应独占一行并且位于同一列,同时与引用它们的语句左对齐。
{ }之内的代码块在‘ { ’右边数格数左对齐。
void Function(int x)
{
...//program code
}
if(condition)
{
...//program code
}
else
{
...//program code
}
for(initialization; condition; update)
{
...//program code
}
while(codition)
{
...//program code
}
如果出现嵌套{}, 应该使用缩进
{
...
{
...
}
...
}
五. 长行拆分为多行
代码行最大长度宜控制在70-80个字符以内, 代码不要过长,否则眼睛看不过来,也不便于打印。
长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
if ((very_longer_variale1 >= very_longer_variable2)
&& (very_longer_varial3 <= very_longer_varial4)
&& (very_longer_varia5 <= very_longer_varial6))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix(CMatrix LeftMatrix,
CMatrix rightMatrix);
for (very_longer_initalization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
六. 注意修饰符的位置
修饰符*和&应靠近数据类型还是应该靠近变量名,是个有争议的话题。
若修饰符*靠近数据类型,例如:int* x;从语义上讲此写法比较直观,即x使int类型的指针。
上述写法的弊端是容易引起误解,例如:int* x, y;此处的y容易被误解为指针变量。虽然将x和y分行定义可以避免误解,但是人么往往不愿意这么做。
程序的分解符‘{’ 和 ‘}’ 应独占一行并且位于同一列,同时与引用它们的语句左对齐。
{ }之内的代码块在‘ { ’右边数格数左对齐。
void Function(int x)
{
...//program code
}
if(condition)
{
...//program code
}
else
{
...//program code
}
for(initialization; condition; update)
{
...//program code
}
while(codition)
{
...//program code
}
如果出现嵌套{}, 应该使用缩进
{
...
{
...
}
...
}
代码行最大长度宜控制在70-80个字符以内, 代码不要过长,否则眼睛看不过来,也不便于打印。
长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
if ((very_longer_variale1 >= very_longer_variable2)
&& (very_longer_varial3 <= very_longer_varial4)
&& (very_longer_varia5 <= very_longer_varial6))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix(CMatrix LeftMatrix,
CMatrix rightMatrix);
for (very_longer_initalization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
六. 注意修饰符的位置
修饰符*和&应靠近数据类型还是应该靠近变量名,是个有争议的话题。
若修饰符*靠近数据类型,例如:int* x;从语义上讲此写法比较直观,即x使int类型的指针。
上述写法的弊端是容易引起误解,例如:int* x, y;此处的y容易被误解为指针变量。虽然将x和y分行定义可以避免误解,但是人么往往不愿意这么做。
修饰符*和&应靠近数据类型还是应该靠近变量名,是个有争议的话题。
若修饰符*靠近数据类型,例如:int* x;从语义上讲此写法比较直观,即x使int类型的指针。
上述写法的弊端是容易引起误解,例如:int* x, y;此处的y容易被误解为指针变量。虽然将x和y分行定义可以避免误解,但是人么往往不愿意这么做。
所以一般都是这样的写法:
【结语】 本篇文章到这里就结束了, 觉得对自己在写代码中有帮助的话,就一键三连吧, 感谢支持。