第2章 措施的版式 版式固然不会影响措施的成果,但会影响可读性。措施的版式追求清晰、雅观,是措施气势气魄的重要组成因素。
可以把措施的版式比喻为“书法”。好的“书法”可让人对措施一目了然,看得兴致勃勃。差的措施“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请措施员们进修措施的“书法”,补充大学计较机教诲的裂痕,实在很有须要。
2.1 空行 空行起着脱离措施段落的浸染。空行得体(不外多也不外少)将使措施的机关越发清晰。空行不会挥霍内存,固然打印含有空行的措施是会多耗损一些纸张,可是值得。所以不要舍不得用空行。
l 【法则 2-1-1 】 在每个类声明之后、每个函数界说竣事之后都要加空行。拜见示例 2-1 ( a )
l 【法则 2-1-2 】 在一个函数体内,逻揖上密切相关的语句之间不加空行,其它处所应加空行脱离。拜见示例 2-1 ( b )
// 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } |
// 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } |
示例 2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行
2.2 代码行 l 【法则 2-2-1 】 一行代码只做一件工作,如只界说一个变量,或只写一条语句。这样的代码容易阅读,而且利便于写注释。
l 【法则 2-2-2 】 if 、 for 、 while 、 do 等语句自占一行,执行语句不得紧跟其后。岂论执行语句有几多都要加 {} 。这样可以防备书写失误。
示例 2-2 ( a )为气势气魄精采的代码行,示例 2-2 ( b )为气势气魄不良的代码行。
int width; // 宽度 int height; // 高度 int depth; // 深度 |
int width, height, depth; // 宽度高度深度 |
x = a + b; y = c + d; z = e + f; |
X = a + b; y = c + d; z = e + f; |
if (width < height) { dosomething(); } |
if (width < height) dosomething(); |
for (initialization; condition; update) { dosomething(); } // 空行 other(); |
for (initialization; condition; update) dosomething(); other(); |
示例 2-2(a) 气势气魄精采 的代码行 示例2-2(b) 气势气魄不良 的代码行
2 【发起 2-2-1 】 尽大概在界说变量的同时初始化该变量(就近原则)
假如变量的引用处和其界说处相隔较量远,变量的初始化很容易被健忘。假如引用了未被初始化的变量,大概会导致措施错误。本发起可以淘汰隐患。譬喻
int width = 10; // 界说并初绐化width
int height = 10; // 界说并初绐化height
int depth = 10; // 界说并初绐化depth
2.3 代码行内的空格 l 【法则 2-3-1 】 要害字之后要留空格。象 const 、 virtual 、 inline 、 case 等要害字之后至少要留一个空格,不然无法辨析要害字。象 if 、 for 、 while 等要害字之后应留一个空格再跟左括号‘(’,以突出要害字。
l 【法则 2-3-2 】 函数名之后不要留空格,紧跟左括号‘(’,以与要害字区别。
l 【法则 2-3-3 】 ‘(’向后紧跟,‘)’、‘,’、‘ ; ‘向前紧跟,紧跟处不留空格。
#p#分页标题#e#
l 【法则 2-3-4 】 ‘,’之后要留空格,如 Function(x, y, z) 。假如‘ ; ‘不是一行的竣事标记,其后要留空格,如 for (initialization; condition; update) 。
l 【法则 2-3-5 】 赋值操纵符、较量操纵符、算术操纵符、逻辑操纵符、位域操纵符,如“ = ”、“ += ” “ >= ”、“ <= ”、“ + ”、“ * ”、“ % ”、“ && ”、“ || ”、“ << ” , “ ^ ”等二元操纵符的前后该当加空格。
l 【法则 2-3-6 】 一元操纵符如“ ! ”、“ ~ ”、“ ++ ”、“ — ”、“ & ”(地点运算符)等前后不加空格。
l 【法则 2-3-7 】 象“ []”、“ .”、“->” 这类操纵符前后不加空格。
2 【发起 2-3-1 】 对付表达式较量长的 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) && (c<=d)) // 精采的气势气魄 if(a>=b&&c<=d) // 不良的气势气魄 |
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 = &y; // 精采的气势气魄 int * x = & y; // 不良的气势气魄 |
array[5] = 0; // 不要写成 array [ 5 ] = 0; a.Function(); // 不要写成 a . Function(); b->Function(); // 不要写成 b -> Function(); |
示例 2-3 代码行内的空格
2.4 对齐 l 【法则 2-4-1 】 措施的分界符‘ { ‘和‘ } ‘应独有一行而且位于同一列,同时与引用它们的语句左对齐。
l 【法则 2-4-2 】 { } 之内的代码块在‘ { ‘右边数格处左对齐。
示例 2-4 ( a )为气势气魄精采的对齐,示例 2-4 ( b )为气势气魄不良的对齐。
void Function(int x) { … // program code } |
void Function(int x){ … // program code } |
if (condition) { … // program code } else { … // program code } |
if (condition){ … // program code } else { … // program code } |
for (initialization; condition; update) { … // program code } |
for (initialization; condition; update){ … // program code } |
While (condition) { … // program code } |
while (condition){ … // program code } |
假如呈现嵌套的{},则利用缩进对齐,如: { … { … } … } |
示例 2-4(a) 气势气魄精采 的对齐 示例2-4(b) 气势气魄不良 的对齐
2.5 长行拆分 l 【法则 2-5-1 】 代码行最大长度宜节制在 70 至 80 个字符以内。代码行不要过长,不然眼睛看不外来,也未便于打印。
#p#分页标题#e#
l 【法则 2-5-2 】 长表达式要在低优先级操纵符处拆分成新行,操纵符放在新行之首(以便突出操纵符)。拆分出的新行要举办适当的缩进,使排版整齐,语句可读。
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(); } |