CC++ 编程规范.docx
- 文档编号:28195501
- 上传时间:2023-07-09
- 格式:DOCX
- 页数:44
- 大小:40.38KB
CC++ 编程规范.docx
《CC++ 编程规范.docx》由会员分享,可在线阅读,更多相关《CC++ 编程规范.docx(44页珍藏版)》请在冰豆网上搜索。
CC++编程规范
C/C++编程规范
版本变更
Date
Version
Auther
Profile
目录
规范说明4
第一部分文件结构5
第1节头文件(.H)5
第2节定义文件(.CPP/.C)7
第3节文件的组织8
第二部分排版9
第1节空行9
第2节代码行10
第3节代码行内的空格11
第4节对齐12
第5节长行拆分14
第6节修饰符的位置14
第7节注释15
第8节类的版式16
第三部分命名规则18
第四部分表达式和基本语句25
第五部分常量29
第六部分函数30
第1节参数30
第2节返回值31
第3节函数体32
第4节成员函数32
第5节重载、覆盖和隐藏32
第6节内联34
第7节其他34
第七部分内存管理36
第八部分类37
第1节构造函数和析构函数37
第2节拷贝构造函数和赋值函数38
第3节成员变量40
第4节成员函数40
第九部分数据类型41
规范说明
本规范适用的对象是从事C++编程工作的程序员。
本规范各款“规则”或“建议”标准的制定原则:
兼容公司程序部的历史代码,提高公司程序部的代码的可读性、一致性和健壮性,人的效率优先而不是机器效率优先。
本规范中的【规则x-x-x】部分内容为公司强制执行的标准,【建议x-x-x】部分内容为公司推荐的标准。
强制标准:
公司程序部的所有员工编写C++代码不应与该规范的规则标准相抵触,违反规则标准编写的C++代码,由违反者改正。
建议标准:
是一种良好的C++编程风格,由于各种因素公司只推荐使用。
公司程序部员工可以不按照某款建议标准编写C++代码。
对本规范的不同意见或建议可通过正式途径提交,公司将在下一版规范中采纳或不采纳提出的意见或建议。
正式途径由程序部行政部们另行建立。
第一部分文件结构
第1节头文件(.H)
【规则1-1-1】版权的声明
版权的声明位于头文件和定义文件的开头(参见示例1-1-1),主要内容有:
(1)版权信息。
(2)创建者。
(3)创建日期。
(4)简要描述。
【示例1-1-1】
////////////////////////////////////////////////////////////////////////
//Copyright(c)1999-2006,TQDigitalEntertainment,AllRightsReserved
//Author:
WUYongmin
//Created:
2006/03/20
//Describe:
简要描述本文件的功能
////////////////////////////////////////////////////////////////////////
【规则1-1-2】头文件的组成
头文件由三部分内容组成:
(1)头文件开头处的版权声明(参见示例1-1-1)。
(2)预处理块。
(3)函数和类结构声明等。
假设头文件名称为graphics.h,头文件的结构参见示例1-1-2。
【示例1-1-2】
//版权和版本声明见示例1-1,此处省略。
#ifndef_TQ_GRAPHICS_H_//防止graphics.h被重复引用
#define_TQ_GRAPHICS_H_
#if_MSC_VER>1000
#pragmaonce
#endif//_MSC_VER>1000
#include
…
#include“myheader.h”//引用非标准库的头文件,必须使用""
…
namespacetq//命名空间
{
classCBox//类结构声明
{
…
};
…
voidFunction1(…);//全局函数声明
}
#endif//endofdefine_GRAPHICS_H_
【规则1-1-3】防止头文件重复应用预处理块
为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
【规则1-1-4】标准库的头文件的引用
用#include
【规则1-1-5】非标准库头文件的引用
用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。
【规则1-1-6】不允许使用全局类类型变量
尽量不要在头文件中出现象externCClassNameobj这类声明,以防止全局对象初始化时,多个类对象的构造函数和析购函数的调用顺序混乱。
可用全局函数代替全局类类型变量。
【规则1-1-7】发布的头文件应通过完整性检查
发布的头文件(例如:
header.h),应用如下的test.cpp编译通过,以检查头文件相应的完整性与自包含性。
test.cpp文件的内容如下:
#include"header.h"//检查头文件的完整性
#include"header.h"//检查头文件的是否被重复引用
【建议1-1-1】头文件中只存放“声明”而不存放“定义(实现代码)”
在C++语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。
这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。
建议将成员函数的定义与声明分开,不论该函数体有多么小。
如果想通过内联函数提高代码效率,可在定义文件中相应的成员函数实现代码前加上关键字inline(参见规则6-5-1)。
第2节定义文件(.CPP/.C)
【规则1-2-1】定义文件的组成
(1)定义文件开头处的版权声明(参见示例1-1-1)。
(2)对一些头文件的引用。
(3)程序的实现体(包括数据和代码)。
假设定义文件的名称为graphics.cpp,定义文件的结构参见示例1-2-1。
【示例1-2-1】
//版权和版本声明见示例1-1,此处省略。
#include“graphics.h”//引用头文件
…
//类成员函数的实现体
voidCBox:
:
Draw(…)
{
…
}
//全局函数的实现体
voidFunction1(…)
{
…
}
第3节文件的组织
【规则1-3-1】文件应与类设计相对应
将一个类分解给2个文件存储。
一个是头文件(.h),用于声明类的成员变量和成员函数;另一是定义文件(.cpp/.c),用于类的成员变量的初始化和成员函数的具体实现。
【规则1-3-2】不要将多个类的设计放在同一个“头文件/定义文件”中
接口类不必遵守该规则。
【建议1-3-1】目录结构
需要公开的头文件(如接口)保存于Include目录或Inc,将不需要公开的头文件和定义文件保存于Source目录或Src。
【建议1-3-2】不要将一个类的设计放在一个头文件和多个定义文件
如果出现定义文件太大,不得不分解为多个定义文件的情况,应考虑类的设计是否恰当。
第二部分排版
第1节空行
【规则2-1-1】类声明、函数定义之后空行
在每个类声明之后、每个函数定义结束之后都要加空行。
参见示例2-1-1(a)
【规则2-1-2】函数体内,逻辑中断空行
在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
参见示例2-1-1(b)
【示例2-1-1】(a-b)
//空行
voidFunction1(…)
{
…
}
//空行
voidFunction2(…)
{
…
}
//空行
voidFunction3(…)
{
…
}
//空行
while(condition)
{
statement1;
//空行
if(condition)
{
statement2;
}
else
{
statement3;
}
//空行
statement4;
}
示例2-1-1(a)函数之间的空行示例2-1-1(b)函数内部的空行
第2节代码行
【规则2-2-1】if、for、while、do等语句自占一行
执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
这样可以防止书写失误。
示例2-2-1(a)为风格良好的代码行,示例2-2-1(b)为风格不良的代码行。
【示例2-2-1】(a-b)
intnWidth;//宽度
intnHeight;//高度
intnDepth;//深度
intnWidth,nHeight,nDepth;//宽度高度深度
x=a+b;
y=c+d;
z=e+f;
X=a+b;y=c+d;z=e+f;
if(nWidth { dosomething(); } if(nWidth for(initialization;condition;update) { dosomething(); } //空行 other(); for(initialization;condition;update) dosomething(); other(); 示例2-2-1(a)风格良好的代码行示例2-2-1(b)风格不良的代码行 【规则2-2-2】就近原则,变量在使用前才定义 如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。 如果引用了未被初始化的变量,可能会导致程序错误。 【规则2-2-3】变量定义时必须初始化 【示例2-2-2】 intnWidth=10;//定义并初绐化width intnHeight=10;//定义并初绐化height intnDepth=10;//定义并初绐化depth 【建议2-2-1】一行代码只做一件事情 如只定义一个变量,或只写一条语句。 这样的代码容易阅读,并且方便于写注释。 第3节代码行内的空格 【规则2-3-1】‘,’之后要留空格 如Function(x,y,z)。 如果‘;’不是一行的结束符号,其后要留空格,如for(initialization;condition;update)。 【规则2-3-2】二元操作符的前后应当加空格 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。 【规则2-3-3】一元操作符前后不加空格 一元操作符如“! ”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。 【规则2-3-4】“[]”、“.”、“->”这类操作符前后不加空格。 【建议2-3-1】关键字之后要留空格 const、virtual、inline、case等关键字之后至少要留一个空格,否则无法辨析关键字。 if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。 【建议2-3-2】函数名之后不要留空格 紧跟左括号‘(’,以与关键字区别。 【建议2-3-3】‘(’向后紧跟不留空格;‘)’、‘,’、‘;’向前紧跟不留空格 紧跟处不留空格。 【建议2-3-4】较长表达式可以适当地去掉一些空格 对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for(i=0;i<10;i++)和if((a<=b)&&(c<=d)) 【示例2-3-1】 voidFunc1(intnX,intnY,intnZ);//良好的风格 voidFunc1(intnX,intnY,intnZ);//不良的风格 if(nYear>=2000)//良好的风格 if(nYear>=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 a: b;//良好的风格 x=a a: b;//不好的风格 int*x=&y;//良好的风格 int*x=&y;//不良的风格 array[5]=0;//不要写成array[5]=0; a.Function();//不要写成a.Function(); b->Function();//不要写成b->Function(); 第4节对齐 【规则2-4-1】分界符对齐 程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。 【规则2-4-2】分界符内的代码块对齐 {}之内的代码块在‘{’右边数格处左对齐。 示例2-4-1(a)为风格良好的对齐,示例2-4-1(b)为风格不良的对齐。 【示例2-4-1】(a-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-1(a)风格良好的对齐示例2-4-1(b)风格不良的对齐 第5节长行拆分 【规则2-5-1】拆分方法 长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。 拆分出的新行要进行适当的缩进,使排版整齐,语句可读。 【示例2-5-1】 if((very_longer_variable1>=very_longer_variable12) &&(very_longer_variable3<=very_longer_variable14) &&(very_longer_variable5<=very_longer_variable16)) { dosomething(); } virtualCMatrixMultiplyMatrix(CMatrixleftMatrix, CMatrixrightMatrix); for(very_longer_initialization; very_longer_condition; very_longer_update) { dosomething(); } 第6节修饰符的位置 【规则2-6-1】应当将修饰符*和&紧靠类型名,严禁指针变量和值变量同行定义。 例如: char*pszName; int*x,y;//严格禁止 第7节注释 【规则2-7-1】注释不可滥用 注释是对代码的“提示”,而不是文档。 程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。 注释的花样要少。 【规则2-7-2】代码可能是最好的注释 如果代码本来就是清楚的,则不必加注释。 否则多此一举,令人厌烦。 例如 i++;//i加1,多余的注释 【规则2-7-3】注释与代码的一致性 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 不再有用的注释要删除。 【规则2-7-4】注释应当准确、易懂,防止注释有二义性 错误的注释不但无益反而有害。 【规则2-7-5】避免使用缩写 尽量避免在注释中使用缩写,特别是不常用缩写。 【规则2-7-6】注释的位置应与被描述的代码相邻 可以放在代码的上方或右方,不可放在下方。 【建议2-7-1】尽量使用C++的标准注释 C++的标准注释是“//”,C标准注释“/**/”。 【建议2-7-2】段落结束注释 当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。 【示例2-7-1】 /* *函数介绍: *输入参数: *输出参数: *返回值: */ voidFunction(floatx,floaty,floatz) { … } if(…) { … while(…) { … }//endofwhile … }//endofif 第8节类的版式 【建议2-8-1】以行为为中心 将public类型的函数写在前面,而将private类型的数据写在后面,采用这种版式的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么样的接口(或服务)。 【建议2-8-2】将成员函数与成员变量分区排版 分为以下几大块: INTERFACE(public/private)/STATIC(public)/CONST(public/private)/NON-CONST(public/private)。 【示例2-8-1】 classCUser: publicIRole { //ConstructorandDestructor public: CUser(SOCKETsck); Virtual~CUser(void); private: SOCKETm_sck; //InterfaceofIRole public: virtualvoidGetID(void)const; virtualOBJTYPEGetObjType(void)const; private: IRecord*m_pRec; //CONST public: voidOp1()const; voidOp2()const; protected: voidOp3()const; private: inti,j; floatx,y; //NON-CONST //Static public: staticvoidFunc1(void); staticvoidFunc2(void); } 第三部分命名规则 【规则3-1-1】直观且可以拼读 标识符应当直观且可以拼读,可望文知意,不必进行“解码”。 标识符最好采用英文单词或其组合,便于记忆和阅读。 切忌使用汉语拼音来命名。 程序中的英文单词一般不会太复杂,用词应当准确。 例如不要把nCurrentValue写成nNowValue。 本地化变量命名可采用拼音,但需加上明确的注释。 【规则3-1-2】命名既不要太长,也不用太短 标识符的长度应当符合“min-length&&max-information”原则。 几十年前老ANSIC规定名字不准超过6个字符,现今的C/C++不再有此限制。 一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。 那么名字是否越长约好? 不见得! 例如变量名maxVal就比maxValueUntilOverflow好用。 单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。 【规则3-1-3】不要仅靠大小写区分标识符 程序中不要出现仅靠大小写区分的相似的标识符。 例如: intx,X;//变量x与X容易混淆 voidfoo(intx);//函数foo与FOO容易混淆 voidFOO(floatx); 【规则3-1-4】局部变量和全局变量不可同名 程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。 【规则3-1-5】使用“名词”做变量名 变量的名字应当使用“名词”或者“形容词+名词”。 例如: floatfValue; floatfOldValue; floatfNewValue; 【规则3-1-6】使用“名词+动词”做全局函数名,使用“动词”做类成员函数名 全局函数的名字应当使用“名词+动词”,强调名词在前。 类的成员函数应当使用“动词”或者“动词+名词”, 例如: BitmapDraw();//全局函数 pBitmap->Draw();//类的成员函数 pBitmap->GetWidth(); 【规则3-1-7】用正确的反义词组 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例如: intnMinValue; intnMaxValue; voidSetValue(…); intGetValue(…); 【规则3-1-8】尽量避免名字中出现数字编号 如Value1,Value2等,除非逻辑上的确需要编号。 这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。 【规则3-1-9】自定义类型名 自定义类型是指非C++标准的内置数据类型,包括: 类类型、结构类型、联合类型、枚举类型以及由typedef定义的类型。 (1)类类型名用“C”加大写字母开头的单词组合而成; 例如: classCNode;//类名 接口类类型名用“I”加大写字母开头的单词组合而成; 例如: classIRole;//接口类名 模板类类型名用“T”加大写字母开头的单词组合而成。 例如: classTEncryptor;//模板类名 (2)结构,联合,枚举,typedef定义类型名用全部大写字母的单词组合而成,单词间加下划线连接。 例如: st
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- CC+ 编程规范 CC 编程 规范