C++编码规范.docx

1、C+编码规范C+编程规范文档版本号：文档编号：文档密级：归属部门/项目：产品名：子系统名：编写人：编写日期：卓望数码技术（深圳）有限公司 版权所有内部资料 注意保密修订记录：版本号修订人修订日期修订描述V1.0A周昀2006-4-24创建初稿V1.0B徐勇2008-10-21根据C+的编码特性修订为工具组编码规范派发清单： 发文人/部门日期电话/传真受文人/部门动作类型*日期电话/传真动作类型：批准、审核、通知、归档、参与会议，其它（请说明） 目 录 第1章 文件结构 41.1 版权和版本的声明 41.2 文件命名 41.3头文件的结构 51.4 定义文件的结构 61.5 目录结构 6第2章

2、程序的版式 82.1 空行 82.2 代码行 92.3 代码行内的空格 102.4 对齐 112.5 长行拆分 122.6 修饰符的位置 122.7 注释 132.8 类的版式 14第3章 命名规则 153.1 共性规则 153.2应用程序命名规则 16第4章 64位支持 184.1 64位体系结构 184.2 声明 184.4 赋值 194.4 位操作 204.4 字符串格式化 20 第1章 文件结构每个C+/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）

3、文件。C+/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C+程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。1.1 版权和版本的声明版权和版本的声明位于头文件和定义文件的开头，主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。/* Copyright (c) 2007-2008, ASPIRE TECHNOLOGIES (SHENZHEN) LTD.* File: xxxx.h* Version: MISC2.0.0.0_KERNEL* Description :

4、 对文件中各类的功能、使用示例等* modification history* -* author: lisl 2007-12-17 12:00:00* -*/示例1-1 版权和版本的声明1.2 文件命名 【规则1-2-1】文件名称使用大写字母开头的单词组合而成，单词间的首字母均大写。头文件以.h为后缀，定义文件以.cpp为后缀。 【规则1-2-2】模板类文件的头文件和定义文件分开，头文件以.h为后缀，定义文件以.i为后缀，.h文件中以include包含.i文件。1.3头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1）。（2）预处理块。（3）函数和类结构声

5、明等。假设头文件名称为 graphics.h，头文件的结构参见示例1-2。 【规则1-3-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 【规则1-3-2】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-3-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索），被引用的头文件使用相对路径，如#include “././filename.h”。 【规则1-3-4】模板类文件的头文件和定义文件分开，头文件以.h为后缀，定义文件以.i为后缀，.h文件

6、中以include包含.i文件 【规则1-3-5】在申明公用类时，在类名前添加DLLIMPORT作为前缀，以便在Windows下，该类可以被编译到动态库中。 【规则1-3-6】在申明公用函数时，添加DLLIMPORT作为前缀，以便在Windows下，该函数可以被编译到动态库中。 【建议1-3-1】头文件中只存放“声明”而不存放“定义”在C+ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。 【建议1-3-2】不提倡使用全局变量，尽量不要在头文件中出现象extern

7、int value 这类声明。 【建议1-3-3】建议自定义类名以M作为前缀，以防止与所使用的库中的类名相同。/ 版权和版本声明见示例1-1，此处省略。#ifndef GRAPHICS_H / 防止graphics.h被重复引用#define GRAPHICS_H#include / 引用标准库的头文件#include “myheader.h” / 引用非标准库的头文件DLLIMPORT void Function1(); / 全局函数声明class DLLIMPORT MBox / 类结构声明;#endif示例1-2 C+/C头文件的结构1.4 定义文件的结构定义文件有三部分内容：（1） 定

8、义文件开头处的版权和版本声明（参见示例1-1）。（2） 对一些头文件的引用。（3） 程序的实现体（包括数据和代码）。假设定义文件的名称为 graphics.cpp，定义文件的结构参见示例1-3。/ 版权和版本声明见示例1-1，此处省略。#include “graphics.h” / 引用头文件/ 全局函数的实现体void Function1()/ 类成员函数的实现体void MBox:Draw()示例1-3 C+/C定义文件的结构1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include目录，将定义

9、文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。第2章 程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。2.1 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布

10、局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。 【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1（a） 【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ）/ 空行void Function1() / 空行void Function2() / 空行void Function3() / 空行while (condition) statement1; / 空行 if (condition) statement2; else statement3;

11、/ 空行 statement4; 示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行2.2 代码行 【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加。这样可以防止书写失误。示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。int width; / 宽度int height; / 高度int depth; / 深度int width, height, depth; / 宽度高度深度x

12、= a + b;y = c + d;z = e + f;X a + b; y = c + d; z = e + f;if (width height) dosomething();if (width =”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。 【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for(i=0; i10; i+)和if (a=b) & (c= 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10;

13、i+) / 良好的风格for(i=0;i10;i+) / 不良的风格for (i = 0; I 10; i +) / 过多的空格x = a b ? a : b; / 良好的风格x=aFunction(); / 不要写成 b - Function();示例2-3 代码行内的空格2.4 对齐 【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。 【规则2-4-2】 之内的代码块在右边4个空格处左对齐。 【规则2-4-3】 缩进格式统一使用4个空格字符，不使用Tab字符示例2-4（a）为风格良好的对齐，示例2-4（b）为风格不良的对齐。void Function(i

14、nt x) / program codevoid Function(int x) / program codeif (condition) / program codeelse / program codeif (condition) / program codeelse / program codefor (initialization; condition; update) / program codefor (initialization; condition; update) / program codeWhile (condition) / program codewhile (co

15、ndition) / program code如果出现嵌套的，则使用缩进对齐，如： 示例2-4(a) 风格良好的对齐 示例2-4(b) 风格不良的对齐2.5 长行拆分 【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。 【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if (very_longer_variable1 = very_longer_variable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variable5 Draw(); / 类的成员函数 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：int minValue;int maxValue;int SetValue();int GetValue(); 【规则3-1-9】避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。3.2应用程序命名规则 作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用。 【规则3-2-1】类名用大写字母开头的单词组合而成。