好文档就是一把金锄头!
欢迎来到金锄头文库![会员中心]
电子文档交易市场
安卓APP | ios版本
电子文档交易市场
安卓APP | ios版本

C++编程书写规则.doc

6页
  • 卖家[上传人]:枫**
  • 文档编号:542742223
  • 上传时间:2024-03-23
  • 文档格式:DOC
  • 文档大小:60.01KB
  • / 6 举报 版权申诉 马上下载
  • 文本预览
  • 下载提示
  • 常见问题
    • C++编码书写风格 版式虽然不会影响程序的功能,但会影响可读性程序的版式追求清晰、美观,是程序风格的重要构成因素1.1 空行空行起着分隔程序段落的作用空行得体(不过多也不过少)将使程序的布局更加清晰空行不会浪费内存所以不要舍不得用空行l 【规则1-1-1】在每个类声明之后、每个函数定义结束之后都要加空行示例1-1(a)l 【规则1-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔示例1-1(b )// 空行void Function1(…){ …}// 空行void Function2(…){ …}// 空行void Function3(…){ …}// 空行while (condition){ function; // 空行 if (condition) { } else { }// 空行 function;} 示例1-1(a) 函数之间的空行 示例1-1(b) 函数内部的空行1.2 代码行l 【规则1-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句这样的代码容易阅读,并且方便于写注释l 【规则1-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。

      不论执行语句有多少都要加{}这样可以防止书写失误示例1-2(a)为风格良好的代码行,示例1-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) {…}if (width < height) dosomething();for (initialization; condition; update){…}// 空行other();for (initialization; condition; update) dosomething();other();示例1-2(a) 风格良好的代码行 示例1-2(b) 风格不良的代码行² 【建议1-2-3】尽可能在定义变量的同时初始化该变量(就近原则) int width = 10; // 定义并初绐化width int height = 10; // 定义并初绐化height 1.3 代码行内的空格l 【规则1-3-1】关键字之后要留空格。

      象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字l 【规则1-3-2】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别l 【规则1-3-3】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格l 【规则1-3-4】‘,’之后要留空格,如Function(x, y, z)如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)l 【规则1-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格l 【规则1-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格l 【规则1-3-7】象“[]”、“.”、“->”这类操作符前后不加空格² 【建议1-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格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 = aFunction(); // 不要写成 b -> Function();示例1-3 代码行内的空格1.4 对齐l 【规则1-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列同时与引用它们的语句左对齐。

      l 【规则1-4-2】{ }之内的代码块在‘{’右边数格处左对齐示例1-4(a)为风格良好的对齐,示例1-4(b)为风格不良的对齐void Function(int x){… }void Function(int x){…}if (condition){… }else{… }if (condition){… }else {… }for (initialization; condition; update){… }for (initialization; condition; update){… }While (condition){… }while (condition){… }如果出现嵌套的{},则使用缩进对齐,如: { { … } }示例1-4(a) 风格良好的对齐 示例1-4(b) 风格不良的对齐1.5 长行拆分l 【规则1-5-1】代码行最大长度宜控制在70至80个字符以内代码行不要过长,否则眼睛看不过来,也不便于打印l 【规则1-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();}示例1-5 长行的拆分1.6 修饰符的位置修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题若将修饰符 * 靠近数据类型,例如:int* x; 从语义上讲此写法比较直观,即x是int 类型的指针上述写法的弊端是容易引起误解,例如:int* x, y; 此处y容易被误解为指针变量。

      虽然将x和y分行定义可以避免误解,但并不是人人都愿意这样做l 【规则1-6-1】应当将修饰符 * 和 & 紧靠变量名例如:char *name; int *x, y; // 此处y不会被误解为指针1.7 注释C语言的注释符为“/*…*/”C++语言中,程序块的注释常采用“/*…*/”,行注释一般采用“//…”注释通常用于:(1)版本、版权声明;(2)函数接口说明;(3)重要的代码行或段落提示虽然注释有助于理解代码,但注意不可过多地使用注释参见示例1-6l 【规则1-7-1】注释是对代码的“提示”,而不是文档程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱注释的花样要少l 【规则1-7-2】如果代码本来就是清楚的,则不必加注释否则多此一举,令人厌烦例如 l 【规则1-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性不再有用的注释要删除l 【规则1-7-4】注释应当准确、易懂,防止注释有二义性错误的注释不但无益反而有害l 【规则1-7-5】尽量避免在注释中使用缩写,特别是不常用缩写l 【规则1-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。

      l 【规则1-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读/** 函数介绍:* 输入参数:* 输出参数:* 返回值 :*/void Function(float x, float y, float z){}if (…){ while (…) {} // end of while} // end of if示例1-6 程序的注释1.8 类的版式类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)类提供关键字public、protected和private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的这样可以达到信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容我们不可以滥用类的封装功能,不要把它当成火锅,什么东西都往里扔类的版式主要有两种方式:(1)将private类。

      点击阅读更多内容
      手机版 | 川公网安备 51140202000112号 | 经营许可证(蜀ICP备13022795号)
      ©2008-2016 by Sichuan Goldhoe Inc. All Rights Reserved.