C++编码规范(初稿).docVIP

C++编码规范 XXXXXX信息股份有限公司 2010-9-13 1. 前言 3 2. 格式 3 2.1. 空行 3 2.2. 代码行 4 2.3. 空格 5 2.4. 对齐 6 2.5. 修饰符位置 7 3. 注释 7 3.1. 基本原则 7 3.2. 对文件的注释 7 3.3. 对类的注释 8 3.4. 对函数的注释 8 3.5. 其他需要注释的地方 8 3.6. 注意事项 10 4. 标识符命名 11 4.1. 常量和宏 11 4.2. 变量 12 4.2.1. 一般变量 12 4.2.2. 全局变量 12 4.2.3. 成员变量 12 4.2.4. 静态变量 13 4.2.5. 注意事项 13 4.3. 函数 13 4.4. 类 15 5. 语句使用 16 5.1. 运算符优先级 16 5.1.1. 复合表达式 16 5.1.2. 控制语句比较 17 5.1.3. 循环语句 17 5.1.4. switch语句 18 5.1.5. goto语句 18 5.2. 函数 18 5.3. 类 19 5.4. 内存管理 19 5.4.1. 内存分配方式 19 5.4.2. 指针的注意事项 20 6. 程序组织 20 前言 本编码规范针对C++语言。制定本规范的目的： 提高代码的健壮性，使代码更安全、可靠。 提高代码的可读性，使代码易于查看和维护。 本文档分别对C++程序的格式、注释、标识符命名、语句使用、函数、类、程序组织、公共变量等方面做出了要求。规范分为两个级别——规则和建议。规则级的规范要求开发人员必须要遵守，建议级的规范开发人员应尽量遵守。 各项目组在用C++语言开发项目时，要遵守本规范。 格式 空行 【规则2-1-1】在每个类的声明之后，每个函数的结束之后都要加空行。 【规则2-1-2】在一个函数体内，完成不同功能的部分要用空行隔开。 // 空行 void function1（） { } // 空行 void function2（） { } // 空行 void function3（） { } // 空行 while（condition1） { Statement1; // 空行 if（condition2） { Statement2; } else { Statement3; } // 空行 Statement4; } 示例 代码行 【规则2-2-1】 一行代码只做一件事情，如只定义一个变量或只写一条语句。这样易读而且方便注释。 【规则2-2-2】像if、for、while、do等语句各占一行，执行语句不得紧跟其后。不论执行多少语句都要加{}。 【建议2-2-3】尽可能在定义变量的同时初始化该变量（就近原则）。 int width = 0; // 宽度 int height = 0; // 高度 x = a + b; y = c + d; z = e + f; if(width height) { Dosomething(); } for(initialization; condition; updata) { Dosometing(); } // 空行 Other(); int width, height; //宽度，高度 x = a + b; y = c + d; z = e + f; if(width height) Dosomething(); for(initialization; condition; updata) Dosometing(); Other(); 示例一：风格良好的代码行 示例二：风格不良好的代码行 空格 【规则2-3-1】关键字之后要留空格。如const、virtual、inline、case等关键字之后要至少留一个空格。while、for、if等关键字之后要留一个空格再跟左括号“（”，以突出关键字。 【规则2-3-2】在使用赋值运算符、比较操作符、逻辑运算符、位运算符、算术运算符等二元操作符时，在其两边各加一个空格。如“=”, “+=”, “-=”, “*=”, “/=”, “%=”,“=”, “=”,“ +”,“*”,“%”,“”,“||”,“”, “^”,“|=”,“^=”等。 【规则2-3-3】函数名之后不要留空格。 【规则2-3-4】‘（’向后紧跟，‘）’、‘,’、‘;’向前紧跟，紧跟处不留空格。‘，’之后要留空格，如func（x, y, z）。如果‘;’不是一行的结束符号，其后要留空格，如for（initilization; condition; update） 【规则2-3-5】不要在引用操作