C++编码规范

第0章 为什么要用C++ 
0.1 原因 
0.2 语言的发展和代码复用 
0.3 代码复用的特点 
0.4 代码复用对我们的影响 
第1章 命名原则 
原则1.1 关于类型名 
原则1.2 关于变量和函数名 
原则1.3 关于全大写的函数名(建议) 
原则1.4 关于宏、常量和模板名 
原则1.5 关于指针标识符名(供参考) 
原则1.6 关于变量名前缀(供参考) 
原则1.7 关于匿名命名空间级标识符的前缀 
原则1.8 减少匿名命名空间级标识符 
原则1.9 命名时避免使用国际组织占用的格式 
原则1.10 名字要本着清楚、简单的原则 
原则1.11 尽量用可发音的名字 
原则1.12 尽量用英文命名 
原则1.13 尽量选择通用词汇并贯穿始终 
原则1.14 避免用模棱两可、晦涩或不标准的缩写 
原则1.15 避免使用会引起误解的词汇 
原则1.16 减少名字中的冗余信息 
原则1.17 建议起名尽量通俗，太专一会限制以后的扩展 
原则1.18 名字最好尽可能精确地表达其内容 
原则1.19 避免名字中出现形状混淆的字母或数字 
原则1.20 命名类和成员使得“object.method()”有意义 
原则1.21 类和对象名应是名词 
原则1.22 实现行为的类成员函数名应是动词 
原则1.23 类的存取和查询成员函数名应是名词或形容词 
原则1.24 变量名应是名词 
原则1.25 布尔型的名字要直观 
原则1.26 关于函数的左值参数和右值参数名 
原则1.27 避免局部名和外层的名字冲突 
原则1.28 用a、an、any区分重名(参数) 
原则1.29 模板类型名应有意义 
第2章 类型的使用 
原则2.1 避免隐式声明类型 
原则2.2 慎用无符号类型 
原则2.3 少用浮点数除非必须 
原则2.4 用typedef简化程序中的复杂语法 
原则2.5 少用union 
原则2.6 慎用位操作 
原则2.7 用enum取代(一组相关的)常量 
原则2.8 使用内置bool类型 
原则2.9 (尽量)用引用取代指针 
第3章 函数 
原则3.1 一定要做到先定义后使用 
原则3.2 函数原型声明放在一个头文件中 
原则3.3 函数无参数一定要用void标注 
原则3.4 对于内置类型参数应传值(除非函数内部要对其修改) 
原则3.5 对于非内置类型参数应传递引用(首选)或指针 
原则3.6 关于何时用指针传递参数 
原则3.7 避免使用参数不确定的函数 
原则3.8 若不得不使用参数不确定的函数，用<stdarg.h>提供的方法 
原则3.9 避免函数的参数过多 
原则3.10 尽量保持函数只有唯一出口 
原则3.11 显式定义返回类型 
原则3.12 (非void)任何情况都要有返回值 
原则3.13 若函数返回状态，尝试用枚举作类型 
原则3.14 返回指针类型的函数应该用NULL表示失败 
原则3.15 函数尽量返回引用(而不是值) 
原则3.16 若必须返回值，不要强行返回引用 
原则3.17 当函数返回引用或指针时，用文字描述其有效期 
原则3.18 禁止成员函数返回成员(可读写)的引用或指针 
原则3.19 重复使用的代码用函数替代 
原则3.20 关于虚友元函数 
原则3.21 关于虚构造函数 
第4章 类的设计和声明 
原则4.1 类应是描述一组对象的集合 
原则4.2 类成员应是私有的(private) 
原则4.3 保持对象状态信息的持续性 
原则4.4 提高类内聚合度 
原则4.5 降低类间的耦合度 
原则4.6 努力使类的接口少而完备 
原则4.7 保持类的不同接口在实现原则上的一致性 
原则4.8 保持不同类的接口在实现原则上的一致性 
原则4.9 避免为每个类成员提供访问函数 
原则4.10 不要在类定义时提供成员函数体 
原则4.11 函数声明(而不是实现)时定义参数的缺省值 
原则4.12 恰当选择成员函数、全局函数和友元函数 
原则4.13 防范、杜绝潜在的二义性 
原则4.14 显式禁止编译器自动生成不需要的函数 
原则4.15 当遇到错误时对象应该应对有度 
原则4.16 用嵌套类的方法减少匿名命名空间类的数量 
第5章 (面向对象的)继承 
原则5.1 “公共继承(public inheritance)”意味着“派生类是基类” 
原则5.2 关于“有”和“由...实现” 
原则5.3 关于继承和模板(template)的区别 
原则5.4 关于继承接口和继承实现 
原则5.5 限制继承的层数 
原则5.6 继承树上非叶子节点的类应是虚基类 
原则5.7 显式提供继承和访问修饰：public、protected或private 
原则5.8 显式指出继承的虚函数 
原则5.9 基类析构函数(destructor)首选是虚函数 
原则5.10 绝不要重新定义(继承来的)非虚函数 
原则5.11 绝不要重新定义缺省参数值 
原则5.12 不要将基类强制转换成派生类
原则5.13 关于C++中的分支用法选择 
原则5.14 慎用多重继承 
原则5.15 所有多重继承的基类析构函数都应是虚函数 
第6章 内存分配和释放 
原则6.1 用new、delete取代malloc、calloc、realloc和free 
原则6.2 new、delete和new[]、delete[]要成对使用 
原则6.3 确保所有new出来的东西适时被delete掉 
原则6.4 谁申请谁释放 
原则6.5 当对象消亡时确保指针成员指向的系统堆内存全部被释放 
原则6.6 自定义类的new/delete操作符一定要符合原操作符的行为规范 
原则6.7 自定义类的new操作符一定要自定义类的delete操作符 
原则 6.8 当所指的内存被释放后，指针应有一个合理的值 
原则6.9 记住给字符串结束符申请空间 
第7章 初始化和清除 
原则7.1 声明后就初始化强于使用前才初始化 
原则7.2 初始化要彻底 
原则7.3 确保每一个构造函数都实现完全的初始化 
原则7.4 尽量使用初始化列表 
原则7.5 初始化列表要按成员声明顺序初始化它们 
原则7.6 构造函数没结束，对象就没有构造出来 
原则7.7 不要用构造函数初始化静态成员 
原则7.8 拷贝构造函数和赋值函数尽量用常量参数 
原则7.9 让赋值函数返回当前对象的引用 
原则7.10 在赋值函数中防范自己赋值自己 
原则7.11 拷贝和赋值要确保彻底 
原则7.12 关于构造函数、析构函数、赋值函数、相等或不等函数的格式 
原则7.13 为大多数类提供缺省和拷贝构造函数、析构函数、赋值函数、相等函数 
原则7.14 只有在有意义时才提供缺省构造函数 
原则7.15 包含资源管理的类应自定义拷贝构造函数、赋值函数和析构函数 
原则7.16 拷贝构造函数、赋值函数和析构函数要么全自定义，要么全生成 
原则7.17 类应有自己合理的拷贝原则：或浅拷贝或深拷贝 
原则7.18 若编译时会完全初始化，不要给出数组的尺寸 
原则7.19 将循环索引的初值定在循环点附近 
原则7.20 确保全局变量在使用前被初始化 
第8章 常量 
原则8.1 关于常量修饰符的含义 
原则8.2 在设计函数原型时，对那些不可能被修改的参数用常量修饰 
原则8.3 类成员可以转换成常量形式暴露出来 
原则8.4 关于常量成员函数 
原则8.5 不要让常量成员函数修改程序的状态 
原则8.6 不要将常量强制转换成非常量 
原则8.7 任何变量和成员函数，首选用const修饰 
第9章 重载 
原则9.1 仔细区分带缺省值参数的函数和重载函数 
原则9.2 确保重载函数的所有版本有共同的目的和相似的行为 
原则9.3 避免重载在指针和整型类型上 
原则9.4 尽量避免重载在模板类型上 
第10章 操作符 
原则10.1 遵守操作符原本的含义，不要创新 
原则10.2 确保自定义操作符能和其他操作符混合使用 
原则10.3 区分作为成员函数和作为友元的操作符 
原则10.4 关于前后缀操作符 
原则10.5 确保相关的一组操作符行为统一 
原则10.6 绝不要自定义operator&&()、operator||()和operator,() 
第11章 类型转换 
原则11.1 尽量避免强制类型转换 
原则11.2 如果不得不做类型转换，尽量用显式方式 
原则11.3 使用新型的类型转换并确保选择正确 
原则11.4 用虚函数方式取代dynamic_cast 
原则11.5 自定义类最好提供显式而不是隐式转换函数 
原则11.6 用关键字explicit防止单参数构造函数的类型转换功能 
原则11.7 限制隐式类型转换的类型数 
原则11.8 避免多个函数提供相同的类型转换 
第12章 友元 
原则12.1 少用友元 
原则12.2 减少拥有友元特权的个数 
第13章 模板 
原则13.1 使用模板如果有限制条件一定要在注释和文档中描述清楚 
原则13.2 模板类型应传引用/指针而不是值 
原则13.3 注意模板编译的特殊性 
原则13.4 嵌套template的>>中间要加空格以区别于operator>> 
第14章 表达式和控制流程 
原则14.1 让表达式直观 
原则14.2 避免在表达式中用赋值语句 
原则14.3 不能将枚举类型进行运算后再赋给枚举变量 
原则14.4 避免对浮点类型做等于或不等于判断 
原则14.5 尝试用范围比较代替精确比较 
原则14.6 范围用包含下限不包含上限方式表示 
原则14.7 关于goto 
原则14.8 在循环过程中不要修改循环计数器 
第15章 宏 
原则15.1 彻底用常量替代(类似功能的)宏 
原则15.2 代码中的数值应由一个有意义的标识符代替 
原则15.3 若宏值多于一项，一定要使用括号 
原则15.4 不要用分号结束宏定义 
原则15.5 彻底用inline函数替代(类似功能的)宏函数 
原则15.6 不好被替代的宏函数 
原则15.7 函数宏的每个参数都要括起来 
原则15.8 不带参数的宏函数也要定义成函数形式 
原则15.9 用{}将函数宏的函数体括起来 
原则15.10 彻底用typedef代替宏定义新类型 
原则15.11 不要在公共头文件中定义宏 
原则15.12 不要用宏改写语言 
第16章 异常(exception)处理 
原则16.1 确保代码在异常出现时能正确处理 
原则16.2 正确注释代码的异常处理能力 
原则16.3 减少不必要的异常处理 
原则16.4 不要利用异常处理机制处理其他功能 
原则16.5 注意模板类型可能会破坏异常处理的一些约定 
原则16.6 确保异常发生后资源还能被回收 
原则16.7 特别当心析构时发生异常 
原则16.8 抛出的异常最好是一个对象 
原则16.9 捕捉异常时绝不要先基类后派生类 
原则16.10 捕捉异常时用引用 
第17章 代码格式 
原则17.1 水平缩进每次用两个空格 
原则17.2 不要在引用操作符前后加空格 
原则17.3 不要在单目操作符和其操作对象间加空格 
原则17.4 不要在“::”前后加空格 
原则17.5 在“,"";”之后(而不是之前)加空格 
原则17.6 在关键字和其后的“(”间加一个空格 
原则17.7 文件中的主要部分用空行分开 
原则17.8 函数间要用空行分开 
原则17.9 组局部变量声明和代码之间用空行分开 
原则17.10 用空行将代码按逻辑片断划分 
原则17.11 可以考虑将if块和else/else if块用空行分开 
原则17.12 函数返回语句要和其他语句用空行分开 
原则17.13 每一行不超过78个字符 
原则17.14 当一条语句超过78个字符时按逻辑划分成不同行 
原则17.15 花括号{}要单独占一行 
原则17.16 花括号中没有或只有一条语句时也不省略花括号 
原则17.17 不要在一行中放多于一条语句 
原则17.18 语句switch中的每个case各占一行 
原则17.19 语句switch中的case按字母顺序排列 
原则17.20 为所有switch语句提供default分支 
原则17.21 若某个case不需要break一定要加注释声明 
原则17.22 变量定义应集中放置、各占一行，并按字母顺序排列 
原则17.23 定义指针和引用时*和&紧跟类型 
原则17.24 按编译器解析顺序放置变量声明的修饰符 
原则17.25 关于函数声明和定义的格式 
原则17.26 函数名和左括号间不要空格 
原则17.27 声明函数时给出参数的名字，除非没有用处 
原则17.28 关于类内不同级别的元素排列顺序 
原则17.29 关于类成员函数的排列顺序 
原则17.30 类成员变量按字母顺序排列 
原则17.31 关于静态成员的访问 
原则17.32 关于字符常量 
原则17.33 用带颜色的编辑器 
第18章 注释 
原则18.1 用英语写全部的注释 
原则18.2 确保注释完善你的代码，而不是重复你的代码 
原则18.3 注释用词要精确，不能有二义性 
原则18.4 注释中的术语要通用 
原则18.5 注释要简单、清楚、切中要害 
原则18.6 注释不能超出被注释代码所包含的内容 
原则18.7 注释中避免引用容易变化的信息 
原则18.8 确保所有注释(随代码)及时更新 
原则18.9 注释不具备约束使用者行为的能力 
原则18.10 注释不要嵌套 
原则18.11 不要用/**/注释掉(大块)代码，应该用#if 0 
原则18.12 区分“战略性”注释和“战术性”注释 
原则18.13 行末注释尽量对齐 
原则18.14 单独的注释行和被注释语句缩进相同的空格 
原则18.15 减少不必要的单独占一行的注释 
原则18.16 对每个#else或#endif给出行末注释 
原则18.17 对每个引用的头文件给出行末注释 
原则18.18 对每个空循环体给出确认性注释 
原则18.19 关于函数注释 
原则18.20 关于注释频率 
第19章 文件和目录 
原则19.1 使用统一而且通用的文件名后缀 
原则19.2 关于文件名的选择 
原则19.3 关于文件/目录名的字符集选择 
原则19.4 关于每个类的文件组成 
原则19.5 关于模板类的文件安排 
原则19.6 保持文件前言的简洁性 
原则19.7 关于文件的段落安排 
原则19.8 关于目录组织 
第20章 头文件 
原则20.1 头文件多次引用的防范 
原则20.2 确保公共头文件的自足性 
原则20.3 只引用需要的头文件 
原则20.4 引用时""和<>的用法 
原则20.5 引用头文件的顺序 
原则20.6 引用时不要用绝对路径 
原则20.7 将函数库放在一个单独的目录下引用 
原则20.8 不要在头文件中定义常量/变量 
原则20.9 任何声明若被多个源文件引用则应在一个头文件中 
原则20.10 在源文件中不要用关键字extern 
第21章 条件编译 
原则21.1 最小化条件编译的使用范围 
原则21.2 若使用#if或#ifdef，不要遗漏#else 
原则21.3 编译条件的含义要具体 
原则21.4 对复杂的编译条件用括号使其清晰 
原则21.5 条件编译和普通条件语句不要混合使用 
原则21.6 若只测试某符号是否存在，不要给该符号赋值 
第22章 编译 
原则22.1 关注编译时的警告(warning)错误 
原则22.2 把问题尽量暴露在编译时而不是运行时 
原则22.3 减少文件的依赖程度 
原则22.4 减少编译时间 
原则22.5 透彻研究编译器 
第23章 兼容性 
原则23.1 遵守ANSI C和ISO C++国际标准 
原则23.2 将不符合国际标准的代码与其他代码分开 
原则23.3 不要假设字符类型是否是有符号类型 
原则23.4 运算时显式转换有符号和无符号类型 
原则23.5 注意双字节字符的兼容性 
原则23.6 恰当使用位操作符 
原则23.7 注意位域(bitfield)变量的兼容性问题 
原则23.8 不要强制引用/指针指向尺寸不同的目标 
原则23.9 确保类型转换不会丢失信息 
原则23.10 不要假设类型的存储尺寸 
原则23.11 如果一定要规定类型的存储尺寸 
原则23.12 不要假设对象(等数据结构)的存储结构 
原则23.13 注意运算溢出问题 
原则23.14 不要假设表达式的运算顺序 
原则23.15 不要假设函数参数的计算顺序 
原则23.16 不要假设不同源文件中静态或全局变量的初始化顺序 
原则23.17 不要依赖编译器基于实现、未明确或未定义的功能 
原则23.18 注意数据文件的兼容性 
原则23.19 注意引用公共库的兼容性 
原则23.20 一定不要重新实现标准库函数 
原则23.21 将所有#include的文件名视为大小写敏感 
原则23.22 代码中用到的路径只用“/”而不要用“/” 
原则23.23 确保main()函数总是返回一个整型 
原则23.24 不要依赖pragmas 
第24章 性能 
原则24.1 使用性能追踪分析工具 
原则24.2 不要用移位代替乘除运算 
原则24.3 如无必要，不要用非int的整型类型 
原则24.4 不要使用关键字register 
原则24.5 避免在循环体内部定义对象 
原则24.6 减少代价很高的对象拷贝 
原则24.7 减少临时对象 
原则24.8 注意大尺寸对象数组 
原则24.9 返回对象(值)的优化 
原则24.10 前缀++和--的效率更高 
原则24.11 恰当使用递归 
原则24.12 恰当地使用inline函数 
原则24.13 虚函数和虚继承效率会有一点损失 
原则24.14 如果合理，使用编译器生成的函数 
原则24.15 如果合理，构造直传类 
原则24.16 关于缓存(cache)类成员 
原则24.17 关于标准库的性能 
原则24.18 关于偷懒 
原则24.19 关于勤快 
原则24.20 80－20原则 
第25章 其他 
原则25.1 避免产生全局数据对象 
原则25.2 确保任何定义只发生一次 
原则25.3 指针操作中用NULL代替0 
原则25.4 不要把NULL用在指针以外的领域 
原则25.5 不要弄巧成拙 
原则25.6 将不再使用的代码删掉 
原则25.7 运行时不要改变进程的环境变量 
原则25.8 该用volatile时一定要用 
原则25.9 不要使用鲜为人知的替换符号 
原则25.10 关于代码审查(code inspection/review)规范 
附录 供参考的源代码