C++C编程规范总则.docx

《C++C编程规范总则.docx》由会员分享，可在线阅读，更多相关《C++C编程规范总则.docx（86页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、C+/C编程规范总则版本历史:版本/状态作者参与者起止时间备注前言5第1章文件结构61.1 版权和版本的声明61.2 头文件的结构61.3 定义文件的结构81.4 头文件的作用81.5 目录结构9第2章 程序的版式102.1 空行102.2 代码行112.3 代码行内的空格122.4 对齐132.6 修饰符的位置142.8 类的版式17第3章命名规则183.1 共性规则183.2 简单的Windows应用程序命名规则203.3 简单的Unix应用程序命名规则错误!未定义书签。第4章 表达式和基本语句224.1 运算符的优先级224.3 1F 语句234.4 循环语句的效率254.5 FOR语句

2、的循环控制变量264.6 SWITCH 语句274.7 GOTO 语句27第5章常量295.1 为什么需要常量295.2 CONST 与 #DEFINE 的比较295.3 常量定义规则295.4 类中的常量306.1 参数的规则326.2 返回值的规则336.3 函数内部实现的规则356.4 其它建议366.5 引用与指针的比较37第7章内存管理397.1 内存分円口方式397.2 常见的内存错误及其对策397.3 指针与数组的对比417.4 指针参数是如何传递内存的? 437.5 FREE和 DELETE把指针怎么啦? 457.6 动态内存会被自动释放吗? 467.7 杜绝“野指针” 467

3、.8 有了 MALLOC/FREE 为什么还要 NEW/DELETE ? 477.9 内存耗尽怎么办? 497.10 MALLOC/FREE 的使用要点507.11 NEW/DELETE 的使用 要点517.12 些心得体会52第8章C+函数的髙级特性538.1 函数重载的概念538.2 成员函数的重载、覆盖与隐藏568.3 参数的缺省值598.4 友算符重载608.5 函数内联618.6 些心得体会64第9章类的构造函数、析构函数与赋值函数659.1 构造函数与析构函数的起源659.2 构造函数的初始化表669.4 示例:类String的构造函数与析构函数689.5 不要轻视拷贝构造函数与赋

4、值函数699.6 示例:类STRING的拷贝构造函数与赋值函数699.7 偷懒的办法处理拷贝构造函数与赋值函数719.8 如何在派生类中实现类的基本函数719.9 些心得体会73第10章类的继承与组合7410.2 组合76第11章其它编程经验7811.1 使用CONST提高函数的健壮性7811.2 提高程序的效率8011.3 一些有益的建议81刖s良好的编程规范能提高编码质量,这点老的工程师和程序员都有共识,一直以来没 有一部统的内部资料供老员参考和新员培训。纵然现在信息发达,资料很多,但 有相当的资料对某些观点表述不一致，为了使得部门编码规范达到统,提高团队的编 码质量，在结合了目前部门特点

5、和此前先进成熟的编程规范,撰写了此文档。第1章文件结构每个C+/C程序通常分为两个文件。个文件用于保存程序的声明(declaration), 称为头文件。另个文件用于保存程序的实现(implementation),称为定义(definition) 文件。C+/C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀,C+程序 的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。1.1 版权和版本的声明版权和版本的声明位丁头文件和定义文件的开头(参见示例1-1),主耍内容有:(1)版权信息。(2)文件名称，标识符，摘要。(3)当前版本号,作者/修改者，完成

6、日期。(4)版本历史信息。* Copyright (c) 2010,福州星网视易数字娱乐研发部 * Al1 rights reserved.* 文件名称:filename, h 文件标识：见配置管理计划书 摘 要：简要描述本文件的内容* 当前版本：1. 1 作 竜:输入作者(或修改者)名字 完成日期：2009年7月20日* 取代版本：1.0 原作者：输入原作者(或修改者)名字 完成日期：2009年5月10日示例1T版权和版本的声明1.2头文件的结构头文件由三部分内容组成:(1)头文件开头处的版权和版本声明(参见示例1-1)。(2)预处理块。(3)函数和类结构声明等。假设头文件名称为graphi

7、cs, h.头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处 理块。对应的宏命名为:文件名一H,见示例说明 【规则1-2-2】用include 格式来引用标准库的头文件(编译器将从 标准库目录开始搜索)。 【规则1-2-3】用#include “filename.h”格式来引用非标准库的头文件(编译器将 从用户的工作目录开始搜索)。令 【建议1-2-1】头文件中只存放“声明”而不存放“定义”在C+语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。 这虽然会带来书写上的方便,但却造成了风格不一致,弊

8、大于利。建议将成员函数的定 义与声明分开,不论该函数体有多么小。 【建议1-2-2】不提倡使用全局变量,尽量不要在头文件屮出现象extern int value这 类声明。/Z版权和版本声明见示例1-1,此处省略。ttifndef GRAPHICS_H /#define GRAPHICS_H防止graphics.h被重复引用ttinclude /引用标准库的头文件#include “myheader.h/引用非标准库的头文件void Functionl (,) ; /全局函数声明class Box/()；#endif类结构声明示例1-2 C+/C头文件的结构1.3 定义文件的结构定义文件有三部

9、分内容:(1)定义文件开头处的版权和版本声明(参见示例1)。(2)对些头文件的引用。(3)程序的实现体(包括数据和代码)。假设定义文件的名称为graphics. cpp,定义文件的结构参见示例1-3。/Z版权和版本声明见示例!-1此处省略。ftinclude “graphics.h” / 引用头文件/全局函数的实现体 void Functionl (,)/Z类成员函数的实现体 void Box:Draw() ()示例1-3 C+/C定义文件的结构1.4 头文件的作用早期的编程语言如Basic, Fortran没有头文件的概念,C+/C语言的初学者虽然会 用使用头文件,但常常不明其理。这里对头文

10、件的作用略作解释:(1)通过头文件来调用库功能。在很多场合，源代码不便(或不准)向用户公布，只要 向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功 能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。(2)头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中 的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的 负担。1.5 目录结构如果个软件的头文件数目比较多（如超过十个）,通常应将头文件和定义文件分别 保存于不同的目录,以便于维护。例如可将头文件保存于include目录,将定义文件保存于source目录（可以是

11、多级 目录如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声 明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2章程序的版式版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是 程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致 勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程 序员们学习程序的“书法”,弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加 清晰。空行不会浪费内存，

12、虽然打印含有空行的程序是会多消耗些纸张，但是值得。 所以不要舍不得用空行。 【规则2-1-1在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1 (a) 【规则2-1-2在个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应 加空行分隔。参见示例2-1 (b ) 【规则2-1-3相对独立的程序块之间、变量说明之后必须加空行。/Z空行void Functionl (,) (/Z空行while (condition) (statement 1;/Z空行void Function2(,) (/Z空行if (condition)statement2;)/Z空行void Function

13、3(,) |jelsestatement 3;/Z空行statement 4;示例2-1 (a)函数之间的空行示例27(b)函数内部的空行2.2 代码行 【规则2-2-1】一行代码只做一件事情,如只定义个变量,或只写一条语句。这样 的代码容易阅读,并且方便于写注释。 【规贝2-2-2】 if、for、wshile、do等语句自占一行,执行语句不得紧跟其后。不论 执行语句有多少都要加。这样可以防止书写失误。示例2-2 (a)为风格良好的代码行,示例2-2 (b)为风格不良的代码行。int width; /Z 宽度 int height; / 高度 int depth; / 深度int width

14、, height, depth; / 宽度高度深度x = a + b; y = c + d; z = e + f;X = a + b; y = c + d; z = e + f;if (width height)(dosomethingO ;!if (width =、“=、 + ”、“*”、“”、“&”、“、，“人”等二元操作符的前后应当加空格。 【规贝2-3-6 一元操作符如”“”、“+”、“一天“&(地址运算符)等前后不加空格。 【规贝2-3-7】象 , , 这类操作符前后不加空格。令 【建议2-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去 掉一些空格,如 fo

15、r (i=0; i10; i+)和 if (a=b) & (c= 2000)if(year=2000)if (a=b) & (c=b&c=d)/Z良好的风格 /不良的风格 /Z良好的风格 /不良的风格for (i=0; i10; i+)for(i=0;i10;i+)for (i = 0; I 10; i +)/Z良好的风格 /不良的风格 /Z过多的空格x=ab?a:b; x=aFunct ion ();/ 不要写成 array 5 = 0;/不要写成a.FunctionO ;/ 不要写成 b - Function();2.4 对齐 【规则2-4-1】程序的分界符和应独占一行并且位于同一列,同时

16、与引用 它们的语句左对齐。 【规则2-4-2之内的代码块在右边数格处左对齐。 【规则2-4-3】程序块要采用缩进风格编写,缩进的空格数为4个。示例2-4 (a)为风格良好的对齐，示例2-4 (b)为风格不良的对齐。void Function(int x)void Function(int x) / program code/ program code )if (condition)if (condition)/ program code / program codeelse else / program codei/ program code1for (initialization; cond

17、ition; update)for (initialization; condition; update) / program code / program code)While (condition)while (condition) / program code / program code 如果出现嵌套的,则使用缩进对齐,如: (1)示例2-4(a)风格良好的对齐示例2-4(b)风格不良的对齐2.5 长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否 则眼睛看不过来,也不便于打印。 【规则2-5-2】K表达式要在低优先级操作符处拆分成,行,操作符放

18、在新亍之(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。if (very_longer_variablel = very_longer_variablel2)& (very_longer_variable3 = very_longer_variablel4)& (verylongervariable5 Draw();/Z类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。说明:下面是些在软件中常用的反义词组。add / removebegin / endcreate / destroyinsert / deletefirst / l

19、astget / releaseincrement / decrementput / getadd / deletelock / unlockopen / closemin / maxold / newstart / stopnext / previoussource / targetshow / hidesend / receivesource / destinationcut / pasteup / down例如:int minValue;int maxValue;int SetValue(.);int GetValue(.); 【建议尽量避免名字中出现数字编号,如Valuel,Value

20、2等,除非逻辑上的 确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名 字(因为用数字编号最省事)。3.2简单的Windows应用程序命名规则作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用,比较适合 于Windows应用软件的开发。 【规则3-2-1类名和函数名用大写字母开头的单词组合而成。例如:classNode;/Z类名classLeaf Node;/Z类名voidDraw (void) ;/Z函数名voidSetValue(int value) ; /Z函数名 【规则3-2-2变量和参数用小写字母开头的单词组合而成。例如：BOOL flag;int

21、drawMode; 【规则3-2-3常量全用大写的字母,用下划线分割单词。例如:const int MAX = 100;const int MAX_LENGTH = 100; 【规贝3-2-4静态变量加前缀s_ (表示static)例如:void Init(.)static int s_initValue; /Z 静态变量 【规则3-2-5如果不得已需要全局变量,则使全局变量加前缀且 （表示global）。 例如:int g_howManyPeople;/Z 全局变量int g_howMuchMoney;/Z 全局变量 【规则3-2-6】类的数据成员加前缀m_ （表示member）,这样可以避

22、免数据成员与 成员函数的参数同名。例如:void Object:SetValue（int width, int height）m_width = width：m_height = height;【规则3-2-7】为了防止某软件库中的一些标识符和其它软件库中的冲突,可以为 各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数 均以gl开头，所有常量（或宏定义）均以GL开头。第4章 表达式和基本语句读者可能怀疑:连if、for、while、goto、switch这样简单的东西也要探讨编程风 格,是不是小题大做?很多程序员用隐含错误的方式写表达式和基本语句,犯过类似的错误。表

23、达式和语句都属于C+/C的短语结构语法。它们看似简单,但使用时隐患比较多。 本章归纳了正确使用表达式和语句的些规则与建议。4.1 运算符的优先级C+/C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示。注意一元 运算符+ - 的优先级高于对应的二元运算符。优先级运算符结合律 - .从左至右从! + - 【规则4-1-1】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免 使用默认的优先级。由于将表4-1熟记是比较困难的，为了防止产生歧义并提高可读性，应当用括号确 定表达式的操作顺序。例如:word = (high 8) I lowif (a lb) & (a & c)（类型

24、）sizeof &从右至左* / %从左至右高+ -从左至右 从左至右到 =从左至右=!=从左至右低&从左至右排A从左至右1从左至右列&从左至右II从右至左?.从右至左=+=-1= v= b & c d & c + f = g + h ; /Z复合表达式过于复杂 【规则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是数学表达式而不是程序表达式并不表示i

25、f (ab) & (bc)而是成了令人费解的if ( (ab)=或“=-EPSIN0N) & (x=EPSINON) 其中EPSINON是允许的误差(即精度)。le-64.3.4 指针变量与零值比较 【规则4-3-4】i籽指针変川“=”或！=”与NIL比较。指针变量的零值是“空”(记为NULL)尽管NULL的值与0相同，但是两者意义不 同。假设指针变量的名字为P，它与零值比较的标准if语句如下:if (p = NULL) / p与NULL显式比较,强调p是指针变量if (p != NULL)不要写成if(P = 0) /Z容易让人误解P是整型变量if (p != 0)或者if (p)/Z容易让

26、人误解p是布尔变量if (!p)4.3.5 对if语句的补充说明有时候我们可能会看到if (NULL = p)这样古怪的格式。不是程序写错了,是程 序员为将i(p = NULL)误写成if (p = NULL),而雷意把p和NULL颠倒编 译器认为if (p = NULL)是合法的,但是会指出if (NULL = p)是错误的,因为NULL 不能被赋值。程序中有时会遇到if/else/return的组合,应该将如下不良风格的程序 if (condition)return x;return y;改写为if (condition)return x;)elsereturn y;)或者改写成更加简练的 return (condition ? x : y);在本部门中,采用此种方式,把指针和值放在前面4.4 循环语句的效率C+/C循环语句中,for语句使用频率最高,while语句其次,do语句很少用。本节 重点论述循环体的效率。提高循环体效率的基本办法是降低循环体的复杂性。 【建议4.4】在多重循环中，如果仃可能,应当将最长的循环在内层短的 循环放在最外层,以减少CPU跨切储环层的次数.例如示例4-4(b)的效率比示例 4-4(a)的髙。for (row=0; rowl 00; row+) (for (col=0