C++程序书写要求规范Word文档下载推荐.docx

C++程序书写要求规范Word文档下载推荐.docx

《C++程序书写要求规范Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《C++程序书写要求规范Word文档下载推荐.docx（13页珍藏版）》请在冰豆网上搜索。

{

……

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++写法

done）{

//GNU写法

●文献[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;

doubletotal=0;

doublespeed=3.0e8;

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”章节

11.类的声明

类的声明如下格式：

//格式1，public等关键字缩进。

文献[1]的格式

classSomeClass:

publicBaseClass

public:

protected:

private:

};

//格式2，VC通行格式，public等关键字不缩进。

文献[2]的格式，建议使用这种格式

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”，即第一个字母大写。

enumBackgr