正文

高质量C++/C编程指南 第二章 程序的版式2006-03-29 13:51:00

【评论】 【打印】 【字体: 】 本文链接:http://blog.pfan.cn/hubian/11566.html

分享到:

  点击排行:1.重装系统 2.几种IP地址搜查方法 3.Windows进程详解-电脑初学者必备 4.高质量C++/C编程指南 第一章 文件结构 5.常见bios短句的解释 上一页 下一页 版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。 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-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】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。 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-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个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。 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(); } 示例2-5 长行的拆分 2.6 修饰符的位置 修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题。 若将修饰符 * 靠近数据类型,例如:int*  x; 从语义上讲此写法比较直观,即x是int 类型的指针。 上述写法的弊端是容易引起误解,例如:int*  x, y; 此处y容易被误解为指针变量。虽然将x和y分行定义可以避免误解,但并不是人人都愿意这样做。   l         【规则2-6-1】应当将修饰符 * 和 & 紧靠变量名 例如: char  *name;     int   *x, y;    // 此处y不会被误解为指针                                             上一页 下一页

阅读(2876) | 评论(0)


版权声明:编程爱好者网站为此博客服务提供商,如本文牵涉到版权问题,编程爱好者网站不承担相关责任,如有版权问题请直接与本文作者联系解决。谢谢!

评论

暂无评论
您需要登录后才能评论,请 登录 或者 注册