高质量C编程指南-版式风格.docx
6页
高质量C++/C编程指南，v 1.0第2章程序的版式版式虽然不会影响程序的功能，但会影响可读性程序的版式追求清晰、美观，是程序风格的重要构成因素可以把程序的版式比喻为“书法”好的“书法”可让人对程序一目了然，看得兴致勃勃差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要2.1 空行空行起着分隔程序段落的作用空行得体(不过多也不过少)将使程序的布局更加清晰空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得所以不要舍不得用空行规则2-1-1］在每个类声明之后、每个函数定义结束之后都要加空行参见示例2-1(a)【规则2-1-2］在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔参见示例2-1(b)//空行voidFunction1(…){…}//空行voidFunction2(…){…}//空行voidFunction3(…){…}//空行while(condition){statement;//空行if(condition){statement2;}else{statement3;}//空行statement4;}示例2-1(a)函数之间的空行示例2-1(b)函数内部的空行2.2 代码行【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。
这样的代码容易阅读，并且方便于写注释规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后不论执行语句有多少都要加{}这样可以防止书写失误示例2-2(a)为风格良好的代码行，示例2-2(b)为风格不良的代码行intwidth;//intheight;//intdepth;//宽度高度深度intwidth,height,depth;//宽度高度深度x=a+b;y=c+d;z=e+f;X=a+b;y=c+d;z=e+f;if(width 如果引用了未被初始化的变量，可能会导致程序错误本建议可以减少隐患例如intwidth=10;//定义并初绐化widthintheight:=10;//定义并初绐化heightintdepth=10;//定义并初绐化depth2.3 代码行内的空格【规则2-3-1］关键字之后要留空格象const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字象if、for、while等关键字之后应留一个空格再跟左括号‘(’，以突出关键字规则2-3-2】函数名之后不要留空格，紧跟左括号‘(’，以与关键字区别规则2-3-3】‘(’向后紧跟，‘)‘、‘，‘、‘；’向前紧跟，紧跟处不留空格规则2-3-4］'之后要留空格，如Function(x,y,z)如果‘；‘不是一行的结束符号，其后要留空格，如for(initialization;condition;update)规则2-3-5］赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“="、"+=”">="、“<="、"+”、“*”、“％”、“&&"、"『、"<<"，""等二元操作符的前后应当加空格规则2-3-6】一元操作符如“！”、“~”、“++”、“--"、“&”(地址运算符)等前后不加空格。 规则2-3-7】象“口”、".”、“->”这类操作符前后不加空格建议2-3-1]对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格,如for(i=0;i<10;i++)和if((a<=b)&&(c<=d))voidFunc1(intx,inty,intz);//良好的风格voidFunc1(intx,inty,intz);//不良的风格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 规则2-4-2]{}之内的代码块在‘{'右边数格处左对齐示例2-4(a)为风格良好的^•齐，示例2-4(b)为风格不良的对齐voidFunction(intx){…//programcode}voidFunction(intx){…//programcode}if(condition){…//programcode}else{…//programcode}if(condition){…//programcode}else{…//programcode}for(initialization;condition;update){…//programcode}for(initialization;condition;update){…//programcode}While(condition){…//programcode)while(condition){…//programcode)如果出现嵌套的{},则使用缩进对齐，如：{…{…)…)示例2-4(a)风格良好的对齐示例2-4(b)风格不良的对齐2.5 长行拆分【规则2-5-1］代码行最大长度宜控制在70至80个字符以内代码行不要过长，否则眼睛看不过来，也不便于打印。 规则2-5-2］长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首(以便突出操作符)拆分出的新行要进行适当的缩进，使排版整齐，语句可读if((very_longer_variable1>=very_longer_variable12)&&(very_longer_variable3<=very_longer_variable14)&&(very_longer_variable5<=very_longer_variable16)){dosomething();}virtualCMatrixCMultiplyMatrix(CMatrixleftMatrix,CMatrixrightMatrix);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分行定义可以避免误解，但并不是人人都愿意这样做规则2-6-1】应当将修饰符*和&紧靠变量名例如：char*name;int*x,y;//此处y不会被误解为指针2.7 注释c语言的注释符为"/*…*/”C++语言中，程序块的注释常采用“/*••・*/"，行注释一般采用“〃…”注释通常用于：(1)版本、版权声明；(2)函数接口说明；(3)重要的代码行或段落提示虽然注释有助于理解代码，但注意不可过多地使用注释参见示例2-6规则2-7-1］注释是对代码的“提示”，而不是文档程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱注释的花样要少规则2-7-2】如果代码本来就是清楚的，则不必加注释否则多此一举，令人厌烦例如i++;//i加1,多余的注释【规则2-7-3］边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性不再有用的注释要删除规则2-7-4】注释应当准确、易懂，防止注释有二义性错误的注释不但无益反而有害规则2-7-5］尽量避免在注释中使用缩写，特别是不常用缩写规则2-7-6］注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方规则2-7-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注if (…){ …while (…){…} // end of while …} // end of if释，便于阅读。 /** 函数介绍：* 输入参数：* 输出参数：* 返回值：* /voidFunctionfloatx,floaty,floatz){…}示例2-6程序的注释2.8类的版式类可以将数据和函数封装在一起，其中函数表示了类的行为(或称服务)类提供关键字public、protected和private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔类的版式主要有两种方式：(1)将private类型的数据写在前面，而将public类型的函数写在后面，如示例8-3(a)采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构2)将public类型的函数写在前面，而将private类型的数据写在后面，如示例8.3(b)采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口(或服务)很多C++教科书受到BiarneStroustrup第一本著作的影响，不知不觉地采用了“以数据为中心”的书写方式，并不见得有多少道理。 我建议读者采用“以行为为中心”的。
