C++编码规范Word文件下载.docx
《C++编码规范Word文件下载.docx》由会员分享,可在线阅读,更多相关《C++编码规范Word文件下载.docx(23页珍藏版)》请在冰点文库上搜索。
![C++编码规范Word文件下载.docx](https://file1.bingdoc.com/fileroot1/2023-5/6/382ef6b0-1ca2-47de-ad66-5c864241939a/382ef6b0-1ca2-47de-ad66-5c864241939a1.gif)
2.7注释12
2.8类的版式13
第3章命名规则14
3.1共性规则14
3.2应用程序命名规则15
第1章文件结构
每个C++/C程序通常分为两个文件。
一个文件用于保存程序的声明(declaration),称为头文件。
另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。
C++/C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀,C++程序的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。
1.1版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头,主要内容有:
(1)版权信息。
(2)文件名称,标识符,摘要。
(3)当前版本号,作者/修改者,完成日期。
(4)版本历史信息。
/**************************************************************************
*Copyright(c)2007-2008,ASPIRETECHNOLOGIES(SHENZHEN)LTD.
*File:
xxxx.h
*Version:
MISC2.0.0.0_KERNEL
*Description:
对文件中各类的功能、使用示例等
*modificationhistory
*--------------------
*author:
lisl2007-12-1712:
00:
00
**************************************************************************/
示例1-1版权和版本的声明
1.2文件命名
●【规则1-2-1】文件名称使用大写字母开头的单词组合而成,单词间使用下化线分割。
头文件以.h为后缀,定义文件以.cpp为后缀。
●【规则1-2-2】模板类文件的头文件和定义文件分开,头文件以.h为后缀,定义文件以.i为后缀,.h文件中以include包含.i文件。
1.3头文件的结构
头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明(参见示例1-1)。
(2)预处理块。
(3)函数和类结构声明等。
假设头文件名称为graphics.h,头文件的结构参见示例1-2。
●【规则1-3-1】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
●【规则1-3-2】用#include<
filename.h>
格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
●【规则1-3-3】用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索),被引用的头文件使用绝对路径,不使用相对路径,如#include“../../filename.h”。
●【规则1-3-4】模板类文件的头文件和定义文件分开,头文件以.h为后缀,定义文件以.i为后缀,.h文件中以include包含.i文件
✧【建议1-3-1】头文件中只存放“声明”而不存放“定义”
在C++语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。
这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。
建议将成员函数的定义与声明分开,不论该函数体有多么小。
✧【建议1-3-2】不提倡使用全局变量,尽量不要在头文件中出现象externintvalue这类声明。
//版权和版本声明见示例1-1,此处省略。
#ifndefGRAPHICS_H//防止graphics.h被重复引用
#defineGRAPHICS_H
#include<
math.h>
//引用标准库的头文件
…
#include“myheader.h”//引用非标准库的头文件
voidFunction1(…);
//全局函数声明
classBox//类结构声明
{
};
#endif
示例1-2C++/C头文件的结构
1.4定义文件的结构
定义文件有三部分内容:
(1)定义文件开头处的版权和版本声明(参见示例1-1)。
(2)对一些头文件的引用。
(3)程序的实现体(包括数据和代码)。
假设定义文件的名称为graphics.cpp,定义文件的结构参见示例1-3。
#include“graphics.h”//引用头文件
//全局函数的实现体
voidFunction1(…)
}
//类成员函数的实现体
voidBox:
:
Draw(…)
示例1-3C++/C定义文件的结构
1.5目录结构
如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。
例如可将头文件保存于include目录,将定义文件保存于source目录(可以是多级目录)。
如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。
为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。
第2章程序的版式
版式虽然不会影响程序的功能,但会影响可读性。
程序的版式追求清晰、美观,是程序风格的重要构成因素。
可以把程序的版式比喻为“书法”。
好的“书法”可让人对程序一目了然,看得兴致勃勃。
差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。
请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。
2.1空行
空行起着分隔程序段落的作用。
空行得体(不过多也不过少)将使程序的布局更加清晰。
空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。
所以不要舍不得用空行。
●【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。
参见示例2-1(a)
●【规则2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
参见示例2-1(b)
//空行
…
voidFunction2(…)
voidFunction3(…)
while(condition)
statement1;
//空行
if(condition)
{
statement2;
}
else
statement3;
statement4;
}
示例2-1(a)函数之间的空行示例2-1(b)函数内部的空行
2.2代码行
●【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。
这样的代码容易阅读,并且方便于写注释。
●【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
这样可以防止书写失误。
示例2-2(a)为风格良好的代码行,示例2-2(b)为风格不良的代码行。
intwidth;
//宽度
intheight;
//高度
intdepth;
//深度
intwidth,height,depth;
//宽度高度深度
x=a+b;
y=c+d;
z=e+f;
X=a+b;
y=c+d;
z=e+f;
if(width<
height)
dosomething();
height)dosomething();
for(initialization;
condition;
update)
other();
dosomething();
示例2-2(a)风格良好的代码行示例2-2(b)风格不良的代码行
✧【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)
如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。
如果引用了未被初始化的变量,可能会导致程序错误。
本建议可以减少隐患。
例如
intwidth=10;
//定义并初绐化width
intheight=10;
//定义并初绐化height
intdepth=10;
//定义并初绐化depth
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;
update)。
●【规则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))
voidFunc1(intx,inty,intz);
//良好的风格
voidFunc1(intx,inty,intz);
//不良的风格
if(year>
=2000)//良好的风格
if(year>
=2000)//不良的风格
if((a>
=d))//良好的风格
if(a>
=b&
c<
=d)//不良的风格
for(i=0;
i++)//良好的风格
for(i=0;
i<
i++)//不良的风格
for(i=0;
I<
10;
i++)//过多的空格
x=a<
b?
a:
b;
x=a<
b?
a:
b;
//不好的风格
int*x=&
y;
//良好的风格
int*x=&
y;
//不良的风格
array[5]=0;
//不要写成array[5]=0;
a.Function();
//不要写成a.Function();
b->
Function();
//不要写成b->
Function();
示例2-3代码行内的空格
2.4对齐
●【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
●【规则2-4-2】{}之内的代码块在‘{’右边4个空格处左对齐。
●【规则2-4-3】缩进格式统一使用4个空格字符,不使用Tab字符
示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。
voidFunction(intx)
…//programcode
voidFunction(intx){
if(condition)
else
if(condition){
else{
update){
While(condition)
while(condition){
如果出现嵌套的{},则使用缩进对齐,如:
…
{
…
}
示例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))
virtualCMatrixCMultiplyMatrix(CMatrixleftMatrix,
CMatrixrightMatrix);
for(very_longer_initialization;
very_longer_condition;
very_longer_update)
示例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】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。
●【规则2-7-9】函数定义前注释格式如下:
/***********************************************************************
*DESCRIPTION:
函数功能说明
*Input:
输入参数说明
*Output:
输出参数说明
*Returns:
返回值说明
*--------------------
*author:
LiaoBingCai2006-03-03
***********************************************************************/
/*
*函数介绍:
*输入参数:
*输出参数:
*返回值:
*/
voidFunction(floatx,floaty,floatz)
if(…)
while(…)
}//endofwhile
}//endofif
示例2-6程序的注释
2.8类的版式
类的版式主要有两种方式:
(1)将private类型的数据写在前面,而将public类型的函数写在后面,如示例8-3(a)。
采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。
(2)将public类型的函数写在前面,而将private类型的数据写在后面,如示例8.3(b)采用这种版式的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么样的接口(或服务)。
统一采用“以行为为中心”的书写方式,即首先考虑类应该提供什么样的函数。
classA
private:
inti,j;
floatx,y;
public:
voidFunc1(void);
voidFunc2(void);
示例8.3(a)以数据为中心版式示例8.3(b)以行为为中心的版式
第3章命名规则
3.1共性规则
在遵循这些共性规则的前提下,再3.2节的规则。
●【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
标识符最好采用英文单词或其组合,便于记忆和阅读。
切忌使用汉语拼音来命名。
程序中的英文单词一般不会太复杂,用词应当准确。
例如不要把CurrentValue写成NowValue。
●【规则3-1-2】标识符的长度应当符合“min-length&
max-information”原则。
几十年前老ANSIC规定名字不准超过6个字符,现今的C++/C不再有此限制。
一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。
那么名字是否越长约好?
不见得!
例如变量名maxval就比maxValueUntilOverflow好用。
单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。
●【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。
intx,X;
//变量x与X容易混淆
voidfoo(intx);
//函数foo与FOO容易混淆
voidFOO(floatx);
●【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。
●【规则3-1-6】变量的名字应当使用“名词”或者“形容词+名词”。
floatvalue;
floatoldValue;
floatnewValue;
●【规则3-1-7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。
类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。
DrawBox();
//全局函数
box->
Draw();
//类的成员函数
●【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
intminValue;
intmaxValue;
intSetValue(…);
intGetValue(…);
✧【规则3-1-9】避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。
3.2应用程序命名规则
作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用。
●【规则3-2-1】类名以‘C’字母开头,由大写字母开头的单词组合而成。
classCNode;
//类名
classCLeafNode;
//类名
●【规则3-2-2】结构名以rec字母开头,由大写字母开头的单词组合而成。
structrecNode;
//结构名
//结构名
●【规则3-2-3】函数名用大写字母开头的单词组合而成。
intDraw(void);
//函数名
voidSetValue(intvalue);
//函数名
●【规则3-2-4】变量和参数用大写字母开头的单词组合而成,再加上变量的类型前缀。