C++编程规范_1.0.0.1

1.头文件的使用

     通常,每一个.cc(或者.cpp)文件(C++的源文件)都有一个对应的.h文件(头文件),也有一些例外,如单元测试代码和只包含main()的.cc(cpp)文件。

     好处:

          01: C++可能有很多源代码文件,而这些源代码是分别单独编译的。如果将将数据都放在各自源文件中,则在调用其他源文件时每次编译都需要在本源文件中声明;所以为了解决这些问题,我们可以将一些共同使用的,经常不会变动的代码放在.h文件中,如类的声明、全局变量等。第一次编译后后续不在需要重新编译,能够加快编译速度。

          02: 头文件中加入一些宏定义来确保文件不被重复包含;如:

                                               #ifndef _FILE_H_

                                               #define  _FILE_H_

                                               。。。。

                                               #endif

          03:  在面向对象编程中,在头文件声明类,源文件定义类的实现能够添加类型判断,防止类的声明或定义出错。

          04:  内联函数 只有当函数只有10行甚至更少时才会将其定义为内联函数(inlinefunction)。

          05:

 

2. 函数参数顺序(FunctionParameterOrdering) 定义函数时,参数顺序为:输入参数在前,输出参数在后。

 

3. 包含文件的名称及次序

     将包含次序标准化可增强可诺性、避免隐藏依赖(hiddendependencies,注:隐藏依赖主要是指包含的文件编译),次序如下:C库、C++库、其他库的.h、项目内的.h。

   !项目内头文件应参照项目源代码目彔树结极排列,避免使用UNIX文件路径.(当前目录)和..(父目录)。

 

4. 作用域

           不要使用using提示符。

 

5.C++类
  01: 构造函数(Constructor)的职责 构造函数中只进行那些没有实际意义的(注:简单初始化对于程序执行没有实际的逻辑意义,
        因为成员变量的“有意义”的值大多不在构造函数中确定)初始化,可能的话,使用Init()方法集中初始化为有意义的(non-trivial)数据。


  02: 默认构造函数(Default Constructors) 如果一个类定义了若干成员变量又没有其他构造函数,需要定义一个默认构造函数,否则编译器
        将自动生产默认构造函数。
 

  03: 明确的构造函数(Explicit Constructors)对单参数构造函数使用C++关键字explicit。
 

  04: 拷贝构造函数(Copy Constructors) 仅在代码中需要拷贝一个类对象的时候使用拷贝构造函数;不需要拷贝时应使用

        DISALLOW_COPY_AND_ASSIGN:

        进行类体设计时,会发现某个类的对象是独一无二的,没有完全相同的对象,也就是对该类对象做副本没有任何意义.因此,需要限制编译器自动生成的拷贝构造函数和赋值构造函数.一般参用下面的宏定义的方式进行限制,代码如下:

       #define DISALLOW_COPY_AND_ASSIGN(TypeName) TypeName(const TypeName &);\
           TypeName & operator=(const TypeName)
           class Test {
             public:
                      Test(int t);
                    ~Test();
             private:
                        DISALLOW_COPY_AND_ASSIGN(Test);
             };

           //相当于重写拷贝构造函数与赋值运算符,并设为private,禁止对象间的赋值、复制。          
  

  05: 结构体和类(Structs vs. Classes) 仅当只有数据时使用struct,其它一概使用class。 如果需要更多的函数功能,class更适合,如果不确定的话,直接使用class。 如果不STL结合,对于仿函数(functors)和特性(traits)可以不用class而是使用struct。


  06: 继承(Inheritance) 使用组合(composition,注,这一点也是GoF在《Design Patterns》里反复强调的)通常比使用继承更适宜,如果使用继承的话,只使用公共继承。
 

  07: 接口(Interface) 接口是指满足特定条件的类,返些类以Interface为后缀(非必需)。


  08: 操作符重载(Operator Overloading) 除少数特定环境外,不要重载操作符。


  09: 存取控制(Access Control) 将数据成员私有化,幵提供相关存取函数,如定义变量foo_及取值函数foo()、赋值函数set_foo()。 存取函数的定义一般内联在头文件中。 参考继承和函数命名。


  10: 声明次序(Declaration Order) 在类中使用特定的声明次序:

           public:在private:之前,成员函数在数据成员(变量)前。
           定义次序如下:public:、protected:、private:,如果那一块没有,直接忽略即可。
          每一块中,声明次序一般如下:
           1) typedef和enum;
           2) 常量;
           3) 构造函数;
           4) 析构函数;
           5) 成员函数,含静态成员函数;
           6) 数据成员,含静态数据成员。 
            宏DISALLOW_COPY_AND_ASSIGN置于private:块之后,作为类的最后部分。


6.其他C++特性 
 1. 引用参数(Reference Arguments) 所有按引用传递的参数必须加上const。
 2. 函数重载(Function Overloading) 仅在输入参数类型不同、功能相同时使用重载函数(含构造函数),不要使用函数重载模仿缺省函数参数。
 3. 缺省参数(Default Arguments) 禁止使用缺省函数参数。
 4. 变长数组和alloca(Variable-Length Arrays and alloca()) 禁止使用变长数组和alloca()。
 5. 友元(Friends) 允许合理使用友元类及友元函数。
 6. 异常(Exceptions) 不要使用C++异常。
 7. 运行时类型识别(Run-Time Type Information, RTTI) 我们禁止使用RTTI。
 8. 类型转换(Casting) 使用static_cast<>()等C++的类型转换,不要使用int y = (int)x戒int y = int(x);。
 9. 流(Streams) 只在记录日志时使用流。
 10. 前置自增和自减(Preincrement and Predecrement) 对于迭代器和其他模板对象使用前缀形式(++i)的自增、自减运算符。
 11. const的使用(Use of const) 我们强烈建议你在任何可以使用的情冴下都要使用const。
 12. 整型(Integer Types) C++内建整型中,唯一用到的是int,如果程序中需要不同大小的变量,可以使用中的精确宽度(precise-width)的整型,如int16_t。
 13. 预处理宏(Preprocessor Macros) 使用宏时要谨慎,尽量以内联函数、枚举和常量代替之。
 14. 0和NULL(0 and NULL) 整数用0,实数用0.0,指针用NULL,字符(串)用'\0'。
 15. sizeof(sizeof) 尽可能用sizeof(varname)代替sizeof(type)。
 
7.命名约定


 1. 通用命名规则(General Naming Rules) 函数命名、变量命名、文件命名应具有描述性,不要过度缩写,类型和变量应该是名词,函数名可以用“命令性”动词。
  如何命名: 尽可能给出描述性名称,不要节约空间,让别人很快理解你的代码更重要,好的命名选择:
  int num_errors; // Good.
  int num_completed_connections; // Good.
  类型和变量名一般为名词:如FileOpener、num_errors。
  函数名通常是指令性的,如OpenFile()、set_num_errors(),访问函数需要描述的更细致,要不其访问的变量相吻合。
  缩写: 除非放到项目外也非常明了,否则不要使用缩写
  不要用省略字母的缩写:
  int error_count; // Good.
  int error_cnt; // Bad.

 2. 文件命名(File Names)
  文件名要全部小写,可以包含下划线(_)或短线(-),按项目约定来。 通常,尽量让文件名更加明确,http_server_logs.h就比logs.h要好,定义类时文件名一般成对出现,如foo_bar.h和foo_bar.cc,对应类FooBar。
 3. 类型命名(Type Names) 类型命名每个单词以大写字母开头,不包含下划线:MyExcitingClass、MyExcitingEnum。 所有类型命名——类、结构体、类型定义(typedef)、枚举——使用相同约定
 4. 变量命名(Variable Names) 变量名一徇小写,单词间以下划线相连,类的成员变量以下划线结尾,如my_exciting_local_variable、my_exciting_member_variable_。 全局变量: 对全局变量没有特别要求,少用就好,可以以g_或其他易与局部变量区分的标志为前缀。
 5. 常量命名(Constant Names) 在名称前加k:kDaysInAWeek。 所有编译时常量(无论是尿部的、全尿的还是类中的)和其他变量保持些许区别,k后接大写字母开头的单词
 6. 函数命名(Function Names) 普通函数(regular functions,译者注,返里不访问函数等特殊函数相对)大小写混合,存取函数(accessors and mutators)则要求不变量名匹配:MyExcitingFunction()、MyExcitingMethod()、my_exciting_member_variable()、set_my_exciting_member_variable()。 普通函数: 函数名以大写字母开头,每个单词首字母大写,没有下划线

 

8.代码注释


 1. 注释风格(Comment Style) 使用//或,统一就好。 //或都可以,//只是用的更加广泛,在如何注释和注释风格上确保统一。
 2. 文件注释(File Comments) 在每一个文件开头加入版权公告,然后是文件内容描述。 法徇公告和作者信息: 每一文件包含以下项,依次是:
  1) 版权(copyright statement):如Copyright 2008 Google Inc.;
  2) 许可版本(license boilerplate):为项目选择吅适的许可证版本,如Apache 2.0、BSD、LGPL、GPL;
  3) 作者(author line):标识文件的原始作者。
   如果你对其他人创建的文件做了重大修改,将你的信息添加到作者信息里,这样当其他人对该文件有疑问时可以知道该联系谁。

 3. 类注释(Class Comments) 每个类的定义要附着描述类的功能和用法的注释。
 4. 函数注释(Function Comments) 函数声明处注释描述函数功能,定义处描述函数实现。 函数定义: 每个函数定义时要以注释说明函数功能和实现要点,如使用的漂亮代码、实现的简要步骤、如此实现的理由、为什么前半部分要加锁而后半部分不需要。 不要从.h文件或其他地方的函数声明处直接复制注释,简要说明函数功能是可以的,但重点要放在如何实现上。
 5. 变量注释(Variable Comments) 通常变量名本身足以很好说明变量用途,特定情冴下,需要额外注释说明。 类数据成员: 每个类数据成员(也叫实例变量或成员变量)应注释说明用途,如果变量可以接受NULL戒-1等警戒值(sentinel values),须说明之。
 6. 实现注释(Implementation Comments) 对亍实现代码中巧妙的、晦涩的、有趣的、重要的地方加以注释。
 7. 标点、拼写和语法(Punctuation, Spelling and Grammar) 留意标点、拼写和语法,写的好的注释比差的要易读的多。 注释一般是包含适当大写和句点(.)的完整的句子,短一点的注释(如代码行尾的注释)可以随意点,依然要注意风格的一致性。完整的句子可读性更好,也可以说明该注释是完整的而不是一点不成熟的想法。 虽然被别人指出该用分号(semicolon)的时候用了逗号(comma)有点尴尬。清晰易读的代码还是很重要的,适当的标点、拼写和语法对此会有所帮助。

 

9.格式
 1. 行长度(Line Length) 每一行代码字符数不超过80。
 2. 非ASCII字符(Non-ASCII Characters) 尽量不使用非ASCII字符,使用时必须使用UTF-8格式。
 3. 直接使用tab,将tab设置为4.

 4. 函数声明与定义(Function Declarations and Definitions) 返回类型和函数名在同一行,合适的话,参数也放在同一行。

 

注意以下几点:
1) 返回值总是和函数名在同一行;
2) 左圆括号(open parenthesis)总是和函数名在同一行;
3) 函数名和左圆括号间没有空格;
4)圆括号与参数间没有空格;
5) 左大括号(open curly brace)总在最后一个参数同一行的末尾处;
6) 右大括号(close curly brace)总是单独位于函数最后一行;
7) 右圆括号(close parenthesis)和左大括号间总是有一个空格;
8) 函数声明和实现处的所有形参名称必须保持一致;
9) 所有形参应尽可能对齐;
10) 缺省缩进为2个空格;
11) 独立封装的参数保持4个空格的缩进。
5. 函数调用(Function Calls) 尽量放在同一行,否则,将实参封装在圆括号中。 
6. 条件语句(Conditionals) 更提倡不在圆括号中添加空格,关键字else另起一行。
7. 循环和开关选择语句(Loops and Switch Statements) switch语句可以使用大括号分块;空循环体应使用{}或continue。
8. 指针和引用表达式(Pointers and Reference Expressions)
 句点(.)或箭头(->)前后不要有空格,指针/地址操作符(*、&)后不要有空格。 = + - * /  && || 等运算符前后各空一空格。
9. 函数返回值(Return Values) return表达式中不要使用圆括号。
10. 变量及数组初始化(Variable and Array Initialization) 选择=还是()。
11. 预处理指令(Preprocessor Directives) 预处理指令不要缩进,从行首开始。
12. 类格式(Class Format) 声明属性依次序是public:、protected:、private:,每次缩进1个空格(译者注,为什么不是两个呢?也有人提倡private在前,对于声明了哪些数据成员一目了然,还有人提倡依逻辑关系将变量与操作放在一起,都有道理:-))。
13. 命名空间格式化(Namespace Formatting) 命名空间内容不缩迕。
14. 水平空白(Horizontal Whitespace) 水平空白的使用因地制宜。不要在行尾添加无谓的空白。
15. 垂直空白(Vertical Whitespace) 垂直空白越少越好。 这不仅仅是规则而是原则问题了:不是非常有必要的话就不要使用空行。尤其是:不要在两个函数定义之间空超过2行,函数体头、尾不要有空行,函数体中也不要随意添加空行。

 
 

 

 

 

??


评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值