C++程序书写规范.docx
《C++程序书写规范.docx》由会员分享,可在线阅读,更多相关《C++程序书写规范.docx(12页珍藏版)》请在冰豆网上搜索。
C++程序书写规范
C++程序书写规范
万健
2009/8/8
一.
前言
在商品化软件开发中,非常重视程序编码规范,不同的公司或组织有不同规范,比如:
“GNUCodingStandards”、“GoogleC++StyleGuide”等。
C++程序编码规范(C++CodingStandard)包含以下两个含义:
1.C++程序设计规范
2.C++程序书写规范
程序设计规范牵涉程序开发过程中可靠性、可维护性、安全性的话题,而程序书写规范是程序员约定的通行书写格式。
本文主要讨论的是C++的程序书写格式。
现在计算机专业教学过程中不重视程序书写格式规范化教学,一些教材中的程序书写格式五花八门,造成学生在大学四年中缺乏规范化的编码训练,直接影响学生毕业求职与工作。
C++的程序书写规范最初缘自K&D的《CProgrammingLanguage》一书以及Unix早期的源代码,一般称为“K&D的风格”,最典型的特征是函数参数声明、带下划线的标识符和花括号的位置,早期的程序缩进通常为8个空格,如下面程序:
intsample_function()
intx,y;/*x和y为函数的形式参数*/
{
……
if(……){
……;
……;
}
……
}
随着C语言的发展,特别是C++的出现,特别是微软公司的Windows程序设计的影响,程序设计风格发生的一系列的变化,出现的GNU、Linux、VC等规范,也出现标识符的匈牙利命名法等规范,主要还是分为Unix/Linux和Windows两大流派,Java的风格偏向于Unix/Linux。
本文主要是综合网络上发布的资料,根据程序开发的通行做法,约定了C++程序的书写规范。
二.C++程序书写规范
1.头文件
头文件必须包含#ifndef…#endif结构。
#ifndefCOM_COMPANY_MODULE_CLASSNAME_H
#defineCOM_COMPANY_MODULE_CLASSNAME_H
:
#endif//COM_COMPANY_MODULE_CLASSNAME_H
参见:
●文献[1]第40条
2.语句
一条语句占一行或多行,避免一行写多条语句,除非这些语句非常相关。
参见:
●文献[2]“OneStatementPerLine”章节
3.程序注释
程序注释包含段注释和行注释两种,段注释单独一行或几行,主要说明下面一段程序完成什么功能,行注释用于解释某条语句的功能。
注意注释书写的对齐。
//该函数完成的功能
voidSampleFunction()
{
//段注释1
……//行注释1
……//行注释2
……
//段注释2
……
if(……)
{
//段注释3
//……
}
}
4.缩进
程序块缩进大小为2到4个空格之间,通常为4个空格。
不用采用TAB控制符,而是采用空格符。
如在VisualStudio2005中选择“工具-选项-文本编辑器-C/C++-制表符-插入空格”、在DEVC++中的“EditorOptions”取消“UseTabCharacter”。
参见:
●文献[1]第38条
●文献[2]“Indentation/Tabs/SpacePolicy”章节
●文献4“Spacesvs.Tabs”章节
5.程序块
程序块的花括号位置有三种写法,推荐采用第一或第二种格式
//现代C/C++写法
while(!
done)
{
doSomething();
done=moreToDo();
}
//传统C/C++写法
while(!
done){
doSomething();
done=moreToDo();
}
//GNU写法
while(!
done)
{
doSomething();
done=moreToDo();
}
参见:
●文献[1]第72条
●文献[5]“FormattingYourSourceCode”章节
6.空行
正如一篇文章中要有自然段一样,在程序中要适当使用空行来表示程序段落。
在必要时,程序段落的开始要加上注释,说明该段程序的功能。
在函数与函数之间,建设有两行以上的空行。
Matrix4x4matrix=newMatrix4x4();
doublecosAngle=Math.cos(angle);
doublesinAngle=Math.sin(angle);
matrix.setElement(1,1,cosAngle);
matrix.setElement(1,2,sinAngle);
matrix.setElement(2,1,-sinAngle);
matrix.setElement(2,2,cosAngle);
multiply(matrix);
在类声明class{}中,public、protected、private节之间加上空行,除非这个类声明的规模很小。
参见:
●文献[1]第86、87条
●文献[4]“ClassFormat”章节
7.空格
空格的使用包含以下几种情况:
(1)双目运算符前后加上空格,单目运算符前后不要加空格
(2)C++保留字后必须加上空格
(3)逗号后面必须加上空格
(4)for语句中的分号后加空格
a=(b+c)*d;//NOT:
a=(b+c)*d
while(true)//NOT:
while(true)
{
...
doSomething(a,b,c,d);//NOT:
doSomething(a,b,c,d);
for(i=0;i<10;i++){//NOT:
for(i=0;i<10;i++){
这几点是所有的代码书写规范中都要求的,但也是程序员最容易忽视的地方。
在运算符前后加上空格,可以大大改善复杂表达式和复杂语句的可读性。
参见:
●文献[1]第84条
8.圆括弧
圆括弧的使用注意以下几点:
(1)不要在关键字后直接跟上圆括弧,中间必须有空格
(2)函数名后直接跟上圆括弧(以示和关键字的区别,但有些规范中要求和关键字一样加上空格)
(3)函数参数名中,括弧和参数之间没有空格(有些规范中有空格,但多数没有)
(4)return语句后不要用圆括弧(如果不是必须的话)
if(condition)
{
}
while(condition)
{
}
strcpy(s,s1);
return1;
参见:
●文献[2]“Parens()withKeyWordsandFunctionsPolicy”章节
●文献[3]“Example17:
Theleftparenthesisalwaysdirectlyafterthefunctionname”章节
●文献[4]“FunctionDeclarationsandDefinitions”章节
9.浮点常量
浮点常量必须有小数点。
doubletotal=0.0;//NOT:
doubletotal=0;
doublespeed=3.0e8;//NOT:
doublespeed=3e8;
doublesum;
sum=(a+b)*10.0;
参见:
●文献[1]第66条
10.对齐
适当地、合理地使用对齐可以使程序更易读。
DWORDmDword
DWORD*mpDword
char*mpChar
charmChar
mDword=0;
mpDword=NULL;
mpChar=NULL;
mChar=0;
ReturnTypeClassName:
:
ReallyLongFunctionName(Typepar_name1,
Typepar_name2,
Typepar_name3)
{
DoSomething();
……
}
参见:
●文献[1]第88条
●文献[2]“AlignmentofDeclarationBlocks”章节
●文献[4]“FunctionDeclarationsandDefinitions”章节
11.类的声明
类的声明如下格式:
//格式1,public等关键字缩进。
文献[1]的格式
classSomeClass:
publicBaseClass
{
public:
……
protected:
……
private:
……
};
//格式2,VC通行格式,public等关键字不缩进。
文献[2]的格式,建议使用这种格式
classSomeClass:
publicBaseClass
{
public:
……
protected:
……
private:
……
};
按照接口与实现分离的原则,一般不要把成员函数的实现放在class{}中。
按public、protected、private的次序声明各成员。
注意在派生类和基类之间的冒号两边加上空格。
参见:
●文献[1]第36、73条
●文献[2]“ClassLayout”章节
12.指针和引用变量
传统的C书写风格,指针变量声明时“*”符号是紧挨在变量名之前,如
int*p1,*p2,*p3;
上述书写方法是C语言设计的缺陷,因为变量类型应是“int*”或不是“int”,近年来C/C++程序设计中流行将“*”紧挨在变量类型之后,这种书写格式要求一行声明一个变量,即
int*p1;
int*p2;
int*p3;
引用类型的“&”符号也类似。
上述两种书写格式均可,但要注意在一个程序代码里只遵循一种书写风格。
参见:
●文献[2]“PointerVariables”章节
●文献[3]“PointersandReferences”章节
●文献[5]“PointerandReferenceExpressions”章节
三.标识符命名规则
标识符的命名用英文,避免使用其它语言或汉语拼音,取名应能表示实际意义。
标识符一般由一个或几个单词构成,单词的首字母大写用于分隔单词。
如果该标识符的作用域比较大,则取名较长;如果单词的作用域较小,写取名较短。
变量用名词或词组、函数名用动词或动词短语。
intnumStudents;//numberofstudents的缩写
voidCreateWindow(…);//CreateWindow的缩写
在GNU的编程规范中,依然延续早期的K&D风格,不主张标识符中大小写字母混用,单词之间用下划线“_”分隔。
参见:
●文献[1]“NamingConventions”章节
●文献[3]“AssignNames”章节
●文献[6]
●文献[7]
●文献[5]“NamingVariables,Functions,andFiles”章节
13.符号常量
符号常量采用全大写字母的方式,单词和单词之间用“_”分隔。
#defineMAX_PATH256
14.类,常数,结构,枚举和类型名
类、常数、结构、枚举和类型名使用“UpperCamelCase”,即第一个字母大写。
enumBackgroundColor
{
None,
Red,
Green,
Blue
};
constintFixedWidth=10;
classBankAccount
{
//...
};
typedeflistPortfolio;
VisualC++的MFC类库中,类名的第一个字母以大写“C”开始,如“CWindow”、“CFile”。
15.变量名,参数名,缩略语
变量名、参数名、缩略语使用“lowerCamelCase”。
intfixedWidth=10;
voidLoadXmlDocumnet(constchar*docName);//注意缩略语XML必须写成Xml
16.函数名
函数名有两种不同的风格:
●lowerCamelCase,为Unix程序设计和Java程序设计风格。
如loadXmlDocument()
●UpperCamelCase,为Windows程序设计风格。
如CreateWindow(…)
17.匈牙利命名法
匈牙利命名法(Hungariannotation)是变量名在上述取名规划的基础上,加上小写字母前缀用于表示数据类型,它的好处是在阅读程序时,看到一个变量名,不用去翻看前面的变量声明类型,直接就可以知道该变量的类型。
对匈牙利命名法有不同的看法,很多观点认为此种命名法过于复杂,而且现代的开发工具在查看程序时,只要光标移动某个变量,可以自动显示这个变量的声量,匈牙利命名法是多余的。
在Windows程序设计里,广泛使用匈牙利命名法(如VC、VB、C++Builder);在Unix和Java程序设计中,匈牙利命令法使用得较少。
匈牙利命名法常用的前缀:
●m_类的数据成员,如m_nLength
●g_全局变量,如g_szConnection
●n或i整型变量,如nLength
●c或ch字符型变量,如cInput
●b布尔型变量,如bFound
●l长整型变量,如lCount
●f单精度浮点型变量,如fRadius
●d双精度浮点型变量,如dRadius
●u无符号变量
●sz以’\0’结束的字符串,如szName
●p指针变量,可以和其它类型前缀联合使用,如pszPath
●r引用变量,可以和其它类型前缀联合使用,如rnStatus
除此之外,还可以根据程序中不同的数据类型(包括自定义的数据类型),自行约定一些前缀,如:
●win表示窗口类型变量,如winResult
●str表示STL的string类型变量,如strMessage
●dw表示DoubleWord变量,如dwFlag
●rect表示矩形图形变量,rectRegion
四.C/C++代码格式化工具
SourceFormatX和astyle是两个较好的C/C++代码格式化工具,它们可以把现有的程序代码按一定的规范进行调整,使得风格更统一。
18.SourceFormatX
SourceFormatX是国产的基于Windows的代码格式化工具,有较强的设定功能。
能较好地处理缩进、运算符左右空格的添加,但不是缩进和空格添加都正确。
19.Astyle
astyle是基于命令行的代码格式化工具,有多个操作系统版本,在Windows系统中必须在命令窗口中使用。
Astyle命令选项格式符合GNU的使用规范。
Astyle是开源软件,安装好以后,源程序放在\astyle\src目录下,这些源程序书写格式非常规范,也符合本文所推荐的格式,可以供程序书写参考。
Astyle的执行程序放在\astyle\bin目录下,在命令行上输入:
\astyle\bin\astylea.cpp
即可把a.cpp的格式进行修正,修正后的代码还是在a.cpp中,修正前的代码放在a.orig文件中。
键入
\astyle\bin\astyle–help
可以看到使用帮助。
Astyle可以按不同的风格规范程序代码,主要是处理缩进,对运算符左右空格不作处理。
五.参考文献
[1]C++ProgrammingStyleGuidelines.http:
//geosoft.no/development/cppstyle.html
[2]C++CodingStandard.
[3]ProgramminginC++,RulesandRecommendations.http:
//www.doc.ic.ac.uk/lab/cplus/c++.rules/
[4]GoogleC++StyleGuide.http:
//google-
[5]GNUCodingStandards.http:
//www.gnu.org/prep/standards/standards.html.
[6]Hungariannotation.http:
//en.wikipedia.org/wiki/Hungarian_notation
[7]C++ProgrammingStyle(C++编码规范).