高质量c编程规范 下载本文

高质量C++/C 编程指南,v 1.0

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=aFunction(); // 不要写成 b -> Function(); 示例2-3 代码行内的空格

2.4 对齐

【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。

示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。 void Function(int x) { ? // program code } if (condition) { ? // program code } else { ? // program code } void Function(int x){ ? // program code } if (condition){ ? // program code } else { ? // program code } 2001

Page 13 of 87

高质量C++/C 编程指南,v 1.0

for (initialization; condition; update) { ? // program code } While (condition) { ? // program code } for (initialization; condition; update){ ? // program code } while (condition){ ? // program code } 如果出现嵌套的{},则使用缩进对齐,如: } 示例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(); } virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix, CMatrix rightMatrix); for (very_longer_initialization; { } dosomething(); very_longer_condition; very_longer_update) { ? { ? } ? 2001

Page 14 of 87

高质量C++/C 编程指南,v 1.0

示例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】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

2001

Page 15 of 87

高质量C++/C 编程指南,v 1.0

/* * 函数介绍: * 输入参数: * 输出参数: * 返回值 : */ void Function(float x, float y, float z) { ? } 示例2-6 程序的注释

2.8 类的版式

if (?) { ? while (?) { ? } // end of while ? } // end of if 类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)。类提供关键字public、protected和private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容。我们不可以滥用类的封装功能,不要把它当成火锅,什么东西都往里扔。

类的版式主要有两种方式:

(1)将private类型的数据写在前面,而将public类型的函数写在后面,如示例8-3(a)。采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。 (2)将public类型的函数写在前面,而将private类型的数据写在后面,如示例8.3(b)采用这种版式的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么样的接口(或服务)。

很多C++教课书受到Biarne Stroustrup第一本著作的影响,不知不觉地采用了“以数据为中心”的书写方式,并不见得有多少道理。

我建议读者采用“以行为为中心”的书写方式,即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰,而且方便别人阅读。因为用户最关心的是接口,谁愿意先看到一堆私有数据成员!”

2001

Page 16 of 87