C C++编程规范.doc

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

1、C和C+编程规范C和C+编程规范作者：日期：审批：日期：目 录1引言31.1文档用途31.2阅读对象31.3参考资料32变量命名规则42.1构成方式42.2变量作用域42.3变量类型42.4特别情况53其他命名规则63.1函数和过程63.2Class(类)63.3Structure(结构)63.4Interface(Corba接口)63.5常数63.6全局标识符64注释74.1源程序头74.2函数或过程74.3代码修改84.4其他注释85代码风格和版式约定95.1一般约定95.2头文件105.3类风格约定116关于跨平台和编译器的处理136.1系统配置头文件compile.h136.2关于in

2、t32和int64137其他参考惯例141 引言1.1 文档用途本文对C以及C+ 的编程的规则和惯例进行说明，以规范后台Unix环境软件的编码。以下定义的各种规则在某些情况下并不是绝对适用，如果按照规则来编写C和C+的源程序，可以避免很多不必要的错误。遵循以下的规则将有助于源程序的阅读和修改，增强软件的可读性、可维护性和移植性。1.2 阅读对象此文档适合以下人员阅读：l 产品开发工程师l 产品维护人员1.3 参考资料2 变量命名规则2.1 构成方式命名的构成方式为变量作用域 + 变量类型 + 基本名说明：1. 变量作用域表明变量的作用范围，用小写，其后跟“_”。2. 变量类型表明变量的数据类型

3、，用小写；3. 基本名，由一个或数个单词组成，构成“主谓”、“动宾”等形式，单词的第一个字母大写，其他字母小写，如Count、RatedCharge。2.2 变量作用域变量类型前缀举例注释全局变量gg nMaxBorrowDay1. g表明此变量是全局变量2. n指此变量是一整数3. MaxBorrowDay是基本名局部变量无nCount1. n指此变量是一整数2. Count是基本名类成员变量mm_nStudentCount1. m表明此变量是类成员变量2. n指此变量是一整数3. StudentCount是基本名2.3 变量类型标志类型描述举例bboolean flag (TRUE, FA

4、LSE)BOOL bAbort; cCharacterchar cInput; n16-bit signed integerint16 nCount; i32-bit signed integerint32 iAmount;ll64-bit signed integerint64 llAmount;strStringstring strBuf;szzero-terminated character arraychar* szString;pPointint32* pNumber;aarray asLine2;fFloatfAmount;ddouble dExRate fpfilepointer

5、(File *)fpFileHandle;2.4 特别情况在函数、事件等过程中，例如，循环中用到的临时变量可直接用i、j、k等形式命名变量。3 其他命名规则3.1 函数和过程动词小写后加“_”分隔符，“_”后所跟的第一个词小写其他字头大写,只允许一个分隔符。如：get_inputString()3.2 Class(类)系统表类，每单词的首字母大写，其它字母小写，不加分隔符，前跟“AI”如：AILocalPlan；其它类，字头大写，不加分隔符，前跟“C”。3.3 Structure(结构)每单词的首字母大写，其它字母小写，不加分隔符，前跟“S”如：SRatedCdr；说明：如无特别必要，Stru

6、ct的命名可以遵循Class的命名。Struct中的数据的命名遵循Class的Member的命名。3.4 Interface(Corba接口)每单词的首字母大写，其它字母小写，不加分隔符，前跟“I”如：IBusiAccept；说明：如无特别必要，Interface的命名可以遵循Class的命名。Interface中的数据的命名遵循Class的Member的命名。Interface中使用到的Structure（结构）的命名规则同3.3中的说明3.5 常数全部大写，词与词之间以“_”为分隔符。如：MAX_DAY_COUNT3.6 全局标识符所有的全局类、全局枚举类型、全局类型定义、全局函数、全局常

7、数、全局变量必须带模块前缀，以保证其全局唯一性。4 注释4.1 源程序头每个源代码文件(包括.c, .cpp, .h, .hpp, .x, .xpp)必须在文件的头部描述文件名、内容、修改记录。修改记录包括日期(YYYY/MM/DD)、创建者/修改者、修改内容，新增的修改记录排在最前。源程序头的注释格式采用 doxygen 风格的形式：例如：/* file cccom.cpp* brief* This file defines the proxy for all communication classes. Also possible* events and errors are define

8、d.* History* 1996/10/25 ReWe integration of missing return values* 1996/10/14 Andreas Welsing #pragma pack() inserted* 1996/06/13 ReWe all timers are set to -1* 1995/10/25 ReWe first release*/4.2 函数或过程在每个函数或过程的前头，要对函数或过程进行以下方面的些注释：注释标记注释描述author作者说明brief函数或过程的功能描述param参数说明return函数返回值的说明see相关文件说明例如：/

9、* * brief* Draws as much of the specified image as is currently available * with its northwest corner at the specified coordinate (x, y). * This method will return immediately in all cases, even if the * entire image has not yet been scaled, dithered and converted * for the current output device. *

10、* author Sami Shaio * author Arthur van Hoff * param img the image to be drawn * param x the x-coordinate of the northwest corner * of the destination rectangle in pixels * param y the y-coordinate of the northwest corner * of the destination rectangle in pixels * return true if the image is complet

11、ely * loaded and was painted successfully; * false otherwise. * see Image * see ImageObserver*/4.3 代码修改代码更新时，需要在SVN的Log Info中说明姓名、日期、更新原因。 4.4 其他注释 变量注释和一般语句注释，注释内容直接跟在语句后。 例：char sUserName30; / the user name if( condition ) /your comments 对代码段的注释信息在代码段前说明。 例： /* */ if（ a = b ） . 5 代码风格和版式约定5.1 一般约定

12、1)每个函数的代码行数控制在60左右，最好不要超过300行。2)类的成员个数控制在15个以内，最好不要超过30个。3)注释不允许嵌套。4)对多条件的判断语句，每个条件语句和子条件要用附上括号。如：if( (a = 0) & (b = TRUE) | (c = d) )5)不同作用域的变量名的基本名不许相同。6)每行的代码长度最好小于80字符，若超过80，用续行符换行或自然的逗号分隔处换行。7)同一层次的代码要有相同的缩进值，用TAB控制缩行值，不要TAB和SPACE混用，TAB使用缺省值4。8)同一层次的、不能在同一行代码中。9)在一个函数或过程中的嵌套层次最好不要超过三层，最多不超过六层。1

13、0)要显式地给出函数或过程的返回值类型。11)避免语句中字符和整型变量的直接比较，要显式地进行类型转换。12)常量定义应该用 const，如： const unsigned MAX_TBL_COUNT = 10;或使用enum类型（参考下条中的例子）13)若常量只在类中使用，应定义在类中如：class CBSRevApipublic:enum MAX_TBL_COUNT = 10;14)指针和引用：在定义指针和引用时，*符号和&符号紧跟在类型名后面，每一行只能定义一个变量，否则会产生错误，如： / NOT RECOMMENDED char* i,j; / i is declared point

14、er to char, while j is declared char15)函数参数尽可能使用引用，对于输入型的参数（不修改参数状态），用const 引用，例如： / a. A copy of the argument is created on the stack. / The copy constructor is called on entry, / and the destructor is called at exit from the function. / This may lead to very inefficient code. void foo1( String s )

15、; String a; foo1( a ); / call-by-value / b. The actual argument is used by the function / and it can be modified by the function. void foo2( String& s ); String b; foo2( b ); / call-by-reference / c. The actual argument is used by the function / but it cannot be modified by the function. void foo3(

16、const String& s ); String c; foo3( c ); / call-by-constant-reference16)内存申请和释放：尽可能避免使用c风格的malloc,realloc,free，使用new/delete；在释放数组时，用delete；5.2 头文件为避免头文件多次包含，在文件头注释之后包含下面两行：#ifndef _FILENAME_H#define _FILENAME_H在文件末尾包含下面一行：#endif / _FILENAME_H其中FILENAME为头文件名，如果头文件在该工程的include目录的下一级子目录，则在文件名前增加“子目录名_”，

17、如：include/util则用下面的格式：#ifndef _UTIL_FILENAME_H#define _UTIL_FILENAME_H#endif / _UTIL_FILENAME_H5.3 类风格约定1）不要定义 public 或 protected 数据成员，以充分发挥C+中的数据封装功能；2）const成员函数：不改变对象类别数据和状态的成员函数应该被定义为const，例如： class SpecialAccount : public Account public: int insertMoney(); / int getAmountOfMoney(); No! Forbids A

18、NY constant object to / access the amount of money. int getAmountOfMoney() const; / Better! / . private: int moneyAmount; ;3）构造和析构函数：需要用new分配实例的类应该定义copy构造函数；4）赋值操作符：需要用new分配实例的类应该定义赋值操作符，同时该操作符应该返回一个rhs对象的一个const reference，以组织a=b=c这种连等的用法，例如：const MySpecialClass&MySpecialClass:operator=( const MySp

19、ecialClass& msp ); / Recommended5）成员函数：public成员函数不能返回一个non-const型的成员数据的引用或指针，例如： class Account public: Account( int myMoney ) : moneyAmount( myMoney ) ; const int& getSafeMoney() const / 正确 int& getRiskyMoney() const return moneyAmount; / 不允许! / . private: int moneyAmount; ;inline const int&Account:

20、getSafeMoney() const return moneyAmount; 6) 在类的定义中不要写实现，用inline函数实现6 关于跨平台和编译器的处理6.1 系统配置头文件compile.hcompile.h是类似与autoconfig生成的配置头文件，用于定义操作系统、硬件平台、编译器等相关的宏，针对不同的平台，会有一个不同的compile.h。考虑到操作的方便性，在本次OPENBOSS的开发中不使用autoconfig 和automake，compile.h手工构造。每一个c/c+源文件的头上，必须第一个包含compile.h。6.2 关于int32和int64在程序中对外部接

21、口函数和数据库数据交换，必须显式使用int32和int64数据类型，不要用int,long,long long这三种数据类型，原则如下表：ORACLE数据类型C数据类型number(1) number(9)int32number(10) number(15)int64其中int64只能用到number(15)主要是因为在ORACLE的接口中，number是用double实现的，而double只有15位有效整数位数。int32和int64定义在compile.h中。7 其他参考惯例除了上述约定外，其他未涉及的内容请参阅下面的附件，有矛盾或冲突的地方，以本文为主。附件：Programming in C+, Rules and Recommendations附件文件名：Ellemtel-rules-mm.html14 / 14