C/C++ 编程规范


软件测试系列 密 级:普通 文件编号:NO.3 文件类别:测试管理体系文件 发 放 号:1003 C/C++ 编程规范 版本:1.0 软件测试系列 目 录 1. 文件结构.................................................................................................................................. 1 1.1 版权和版本的声明.......................................................................................................... 1 1.2 头文件的结构.................................................................................................................. 1 1.3 定义文件的结构.............................................................................................................. 2 1.4 目录结构.......................................................................................................................... 3 2. 程序版式.................................................................................................................................... 3 2.1 空行.................................................................................................................................. 3 2.2 代码行.............................................................................................................................. 4 2.3 代码行内的空格.............................................................................................................. 4 2.4 对齐.................................................................................................................................. 5 2.5 长行拆分.......................................................................................................................... 6 2.6 修饰符的位置.................................................................................................................. 7 2.7 注释.................................................................................................................................. 7 2.8 类的版式.......................................................................................................................... 7 3 命名规则...................................................................................................................................... 8 3.1 共性规则.......................................................................................................................... 8 3.2 Windows 应用程序命名规则 ......................................................................................... 9 3.3 Linux 应用程序函数命名规则 ....................................................................................... 9 4. 表达式和基本语句 ................................................................................................................ 10 4.1 运算符的优先级............................................................................................................ 10 4.2 复合表达式.................................................................................................................... 10 4.3 if 语句 ............................................................................................................................ 10 4.3.1 布尔变量与零值比较......................................................................................... 10 4.3.2 整型变量与零值比较..........................................................................................11 4.3.3 浮点变量与零值比较..........................................................................................11 4.3.4 指针变量与零值比较..........................................................................................11 4.4 循环语句的效率.............................................................................................................11 4.5 for 语句的循环控制变量.............................................................................................. 12 4.6 switch 语句 .................................................................................................................... 12 4.7 goto 语句........................................................................................................................ 13 5. 常量.......................................................................................................................................... 13 5.1 const 与#define 的比较 ................................................................................................ 13 5.2 常量定义规则............................................................................................................... 13 6. 函数设计.................................................................................................................................. 14 6.1 参数的规则.................................................................................................................... 14 6.2 返回值的规则................................................................................................................ 15 6.3 函数内部实现的规则.................................................................................................... 15 6.4 其它建议........................................................................................................................ 15 6.5 使用断言....................................................................................................................... 16 6.6 引用与指针的比较........................................................................................................ 16 软件测试系列 7 重载和内联............................................................................................................................... 16 7.1 普通函数重载................................................................................................................. 16 7.2 内联函数......................................................................................................................... 16 8. 内存管理.................................................................................................................................. 17 9 类的构造函数、析构函数、成员函数与赋值函数.............................................................. 17 9.1 类的构造函数................................................................................................................. 17 9.2 成员函数......................................................................................................................... 17 10. 类的继承和组合................................................................................................................... 17 11. 其他规范及建议.................................................................................................................... 17 11.1 提高程序的效率.......................................................................................................... 17 11.2 一些有益的建议........................................................................................................ 18 编程规范系列 第 1 页 共 18 页 1. 文件结构 每个C++/C 程序通常分为两个文件。一个文件用于保存程序的声明(declaration), 称为头文件。另一个文件用于保存程序的实现( implementation),称为定义( definition) C++/C 程序的头文件以“.h”为后缀,C 程序的定义文件以“. c”为后缀,C++程序 的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。 1.1 版权和版本的声明 版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有: (1)版权信息 (2)文件名称,标识符,摘要 (3)当前版本号,作者/修改者,完成日期 (4)版本历史信息 示例 1-1 版权和版本的声明 版本标识:采用 <主版本号>.<次版本号>.<修订号> 来命名自己产品的编号。Linux 核心还有一个约定, 就是如果次版本号是偶数(如 0、2、4 等),代表正式版本,如果次版本号是奇数(如 1、3、5 等),代 表的是开发过程中的测试版本。修订号则相当于 Build 号,用来标识一些小的改动。 1.2 头文件的结构 头文件由三部分内容组成: 1)头文件开头处的版权和版本声明(参见示例1-1)。 2)预处理块。 /* * Copyright (c) 2003,北京梅梅出品有限公司 * All rights reserved. * * 文件名称:filename.h * 文件标识:见配置管理计划书 * 摘要:简要描述本文件的内容 */ #ifndef GRAPHICS_H // 防止graphics.h 被重复引用 #define GRAPHICS_H 下面其它的声明代码 ……… 下面是原作者、版本、完成、日期和当前版本的信息 /* 当前版本:1.1.2 * 作者:输入作者(或修改者)名字 * 完成日期:2003年5月20日 * * 取代版本:1.1.1 * 原作者:输入原作者(或修改者)名字 * 完成日期:2003年4月10日 */ 编程规范系列 第 2 页 共 18 页 // 版权和版本声明见示例1-1,此处省略。 #ifndef GRAPHICS_H // 防止graphics.h 被重复引用 #define GRAPHICS_H #include // 引用标准库的头文件 … #include “myheader.h” // 引用非标准库的头文件 … void Function1(… ); // 全局函数声明 … class Box // 类结构声明 { … }; #endif // 版权和版本声明见示例1-1,此处省略。 #include “graphics.h” // 引用头文件 … // 全局函数的实现体 void Function1(… ) { ... } // 类成员函数的实现体 void Box::Draw(...) { ... } 3)函数和类结构声明等。 假设头文件名称为graphics.h,头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用,应当用ifndef/define/endif 结构产生预处理块。 【规则1-2-2】用#include < filename.h> 格式来引用标准库的头文件(编译器将从标准库目录开始搜 索)。 【规则1-2-3】用#include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录 开始搜索)。 【建议1-2-1】头文件中只存放“声明”而不存放“定义” 【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。 示例1-2 C++/C 头文件的结构 1.3 定义文件的结构 定义文件有三部分内容: 1) 定义文件开头处的版权和版本声明(参见示例1-1)。 2) 对一些头文件的引用。 3) 程序的实现体(包括数据和代码)。 假设定义文件的名称为graphics.cpp,定义文件的结构参见示例1-3 编程规范系列 第 3 页 共 18 页 示例1-3 C++/C 定义文件的结构 1.4 目录结构 如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的 目录,以便于维护。 例如可将头文件保存于include 目录,将定义文件保存于source 目录(可以是多级目录)。 如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强 信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。 2. 程序版式 2.1 空行 空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会 浪费内存,所以不要舍不得用空行。 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1(a) 【规则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) 函数内部的空行 编程规范系列 第 4 页 共 18 页 2.2 代码行 【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读, 并且方便于写注释。 【规则2-2-2】if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都 要加{}。这样可以防止书写失误。 【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则) 如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的 变量,可能会导致程序错误。本建议可以减少隐患。例如 int width = 10; // 定义并初绐化width int height = 10; // 定义并初绐化height int depth = 10; // 定义并初绐化depth 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.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)。 编程规范系列 第 5 页 共 18 页 【规则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)) 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.4 对齐 【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。 【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。 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 } 编程规范系列 第 6 页 共 18 页 } 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 长行拆分 【规则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; very_longer_condition; very_longer_update) { dosomething(); } 示例2-5 长行的拆分 编程规范系列 第 7 页 共 18 页 2.6 修饰符的位置 【规则2-6-1】将修饰符 * 和 &紧靠变量名 例如: char *name; int * x, y; // 此处y 不会被误解为指针 2.7 注释 C 语言的注释符为“/*⋯ */ ”。C++语言中,程序块的注释常采用“/*⋯ */ ”,行注释一般采用 “//⋯ ”。注释通常用于: (1)版本、版权声明; (2)函数接口说明; (3)重要的代码行或段落提示。 【规则2-7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让 人眼花缭乱。 【规则2-7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。 【规则2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有 用的注释要删除。 【规则2-7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。 【规则2-7-5】尽量避免在注释中使用缩写,特别是不常用缩写。 【规则2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。 【规则2-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。 2.8 类的版式 类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)。类提供关键字public、 protected 和private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到 信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容。 类的版式主要有两种方式: (1)将private 类型的数据写在前面,而将public 类型的函数写在后面,如示例8-3(a)。采用这种版 式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。 (2)将public 类型的函数写在前面,而将private 类型的数据写在后面,如示例8.3(b)采用这种版式 的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么样的接口(或服务)。 【建议2-8-1】建议采用“以行为为中心”的书写方式,即首先考虑类应该提供什么样的函数。这样做 不仅让自己在设计类时思路清晰,而且方便别人阅读。 编程规范系列 第 8 页 共 18 页 class A { private: int i, j; float x, y; … public: void Func1(void); void Func2(void); … } class A { public: void Func1(void); void Func2(void); … private: int i, j; float x, y; … } 示例8.3(a) 以数据为中心版式 示例8.3(b) 以行为为中心的版式 3 命名规则 3.1 共性规则 本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特 定的规则,如3.2 节。 命名两个基本原则:1. 含义清晰,不易混淆; 2. 不和其它模块、系统API的命名空间相冲突即可。 【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。 标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文 单词一般不会太复杂,用词应当准确。例如不要把CurrentValue 写成NowValue 。 【规则3-1-2】标识符的长度应当符合“min-length && max-information”原则。 一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。但名 字并不是越长约好! 例如变量名maxval 就比maxValueUntilOverflow好用。单字符的名字也是有用的, 常见的如i,j,k,m,n,x,y,z 等,它们通常可用作函数内的局部变量。 【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。 例如Windows 应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而Unix 应用程序 的标识符通常采用“小写加下划线”的方式,如add_child。别把这两类风格混在一起用。 【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。 例如:int x, X; // 变量x 与X 容易混淆 void foo(int x); // 函数foo 与FOO 容易混淆 void FOO(float x); 【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会 发生语法错误,但会使人误解。 【规则3-1-6】变量的名字应当使用“名词”或者“形容词+名词”。 例如:float value; float oldValue; 【规则3-1-7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应 当只使用“动词”,被省略掉的名词就是对象本身。 例如: DrawBox(); // 全局函数 编程规范系列 第 9 页 共 18 页 box->Draw(); // 类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例如:int minValue; int maxValue; int SetValue(⋯ ); int GetValue(⋯ ); 【建议3-1-1】尽量避免名字中出现数字编号,如Value1,Value2 等,除非逻辑上的确需要编号。 3.2 Windows 应用程序命名规则 【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。 例如:class Node; // 类名 class LeafNode; // 类名 void Draw(void); // 函数名 void SetValue(int value); // 函数名 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。 例如:BOOL flag; int drawMode; 【规则3-2-3】常量全用大写的字母,用下划线分割单词。 例如:const int MAX = 100; const int MAX_LENGTH = 100; 【规则3-2-4】静态变量加前缀s_(表示static)。 例如:void Init(⋯) { static int s_initValue; // 静态变量 ⋯ } 【规则3-2-5】如果需要定义全局变量,则使全局变量加前缀g_(表示global)。 例如:int g_howManyPeople; // 全局变量 int g_howMuchMoney; // 全局变量 【规则3-2-6】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。 例如:void Object::SetValue(int width, int height) { m_width = width; m_height = height; } 【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能 反映软件性质的前缀。例如三维图形标准OpenGL 的所有库函数均以gl 开头,所有常量(或宏定义)均 以GL 开头。 3.3 Linux 应用程序函数命名规则 函数命名应遵循下面两个原则: 1)属于某一模块的函数,加上前缀,前缀为模块缩写; 编程规范系列 第 10 页 共 18 页 2)函数名应该表明函数意义,格式为"前缀_名词_动词"; 4. 表达式和基本语句 4.1 运算符的优先级 【规则4-1-1】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优先级。 为了防止产生歧义并提高可读性,应当用括号确定表达式的操作顺序。 例如:word = (high << 8) | low if ((a | b) && (a & c)) 4.2 复合表达式 如a = b = c = 0 这样的表达式称为复合表达式。允许复合表达式存在的理由是:(1)书写简洁; (2)可以提高编译效率。但要防止滥用复合表达式。 【规则4-2-1】不要编写太复杂的复合表达式。 例如:i = a >= b && c < d && c + f <= g + h ; // 复合表达式过于复杂 【规则4-2-2】不要有多用途的复合表达式。 例如:d = (a = b + c) + r ; 该表达式既求a 值又求d 值。 应该拆分为两个独立的语句:a = b + c; d = a + r; 【规则4-2-3】不要把程序中的复合表达式与“真正的数学表达式”混淆。 例如: if (a < b < c) // a < b < c 是数学表达式而不是程序表达式 并不表示 if ((a=”或“<=”形式。 假设浮点变量的名字为x,应当将 if (x == 0.0) // 隐含错误的比较 转化为 if ((x>=-EPSINON) && (x<=EPSINON)) 其中EPSINON 是允许的误差(即精度)。 4.3.4 指针变量与零值比较 【规则4-3-4】应当将指针变量用“==”或“!=”与NULL 比较。 指针变量的零值是“空”(记为NULL)。尽管NULL 的值与0 相同,但是两者意义不同。假设指针 变量的名字为p,它与零值比较的标准if 语句如下: if (p == NULL) // p 与NULL 显式比较,强调p 是指针变量 if (p != NULL) 不要写成 if (p == 0) // 容易让人误解p 是整型变量 if (p != 0) 或者 if (p) // 容易让人误解p 是布尔变量 if (!p) 4.4 循环语句的效率 C++/C 循环语句中,for 语句使用频率最高,while 语句其次,do 语句很少用。本节重点论述循 环体的效率。提高循环体效率的基本办法是降低循环体的复杂性。 【建议4-4-1】在多重循环中,如果有可能,应当将最长的循环放在最内层,最短的循环放在最外层, 以减少CPU 跨切循环层的次数。例如示例4-4(b)的效率比示例4-4(a)的高。 编程规范系列 第 12 页 共 18 页 for (row=0; row<100; row++) { for ( col=0; col<5; col++ ) { sum = sum + a[row][col]; } } for (col=0; col<5; col++ ) { for (row=0; row<100; row++) { sum = sum + a[row][col]; } } 示例4-4(a) 低效率:长循环在最外层 示例4-4(b) 高效率:长循环在最内层 【建议4-4-2】如果循环体内存在逻辑判断,并且循环次数很大,宜将逻辑判断移到循环体的外面。示 例4-4(c)的程序比示例4-4(d)多执行了N-1 次逻辑判断。并且由于前者总要进行逻辑判断,打断了循环 “流水线”作业,使得编译器不能对循环进行优化处理,降低了效率。如果N 非常大,最好采用示例4-4(d) 的写法,可以提高效率。如果N 非常小,两者效率差别并不明显,采用示例4-4(c)的写法比较好,因 为程序更加简洁。 for (i=0; i=”这类符号也很容易发生“丢失”失误。然而编译器却不一定能自 动指出这类错误。 【建议11-2-2】变量(指针、数组)被创建之后应当及时把它们初始化,以防止把未被初始化的变量当 成右值使用。 【建议11-2-3】当心变量的初值、缺省值错误,或者精度不够。 【建议11-2-4】当心数据类型转换发生错误。尽量使用显式的数据类型转换,避免让编译器轻悄悄地进 行隐式的数据类型转换。 【建议11-2-5】当心变量发生上溢或下溢,数组的下标越界。 【建议11-2-6】当心忘记编写错误处理程序,当心错误处理程序本身有误。 【建议11-2-7】当心文件I/O 有错误。 【建议11-2-8】避免编写技巧性很高代码。 【建议11-2-9】不要设计面面俱到、非常灵活的数据结构。 【建议11-2-10】如果原有的代码质量比较好,尽量复用它。但是不要修补很差劲的代码,应当重新编 写。 【建议11-2-11】尽量使用标准库函数,不要“发明”已经存在的库函数。 【建议11-2-12】尽量不要使用与具体硬件或软件环境关系密切的变量。 【建议11-2-13】把编译器的选择项设置为最严格状态。 【建议11-2-14】如果可能的话,使用LogiScope 等工具进行代码审查。
还剩20页未读

继续阅读

下载pdf到电脑,查找使用更方便

pdf的实际排版效果,会与网站的显示效果略有不同!!

需要 8 金币 [ 分享pdf获得金币 ] 0 人已下载

下载pdf

pdf贡献者

snutz

贡献于2012-12-15

下载需要 8 金币 [金币充值 ]
亲,您也可以通过 分享原创pdf 来获得金币奖励!
下载pdf