C++编码规范（初稿）.doc

会签部门 会签人 会签部门 会签人 C++编码规范 目 录 简介 5 1.1 目的 5 1.2 范围和说明 5 1.3 定义、首字母缩写词和缩略语 5 1.4 参考资料 5 2 文件 7 2.1 格式 7 2.1.1 行长度 7 2.1.2 行缩进 7 2.1.3 指针和引用表达式 7 2.1.4 类/结构 7 2.1.5 函数 12 2.1.6 变量、常量 14 2.1.7 宏 16 2.2 头文件 16 2.3 内联函数定义文件 17 2.4 实现文件 18 2.5 文件版本 18 3 命名 20 3.1 文件命名 20 3.2 类型命名 21 3.3 类/结构 22 3.4 函数 22 3.5 变量 24 3.6 宏、枚举值 27 4 注释 28 4.1 文件头注释 28 4.2 类注释 28 4.3 函数注释 30 4.4 代码注释 31 4.5 变量、常量、全局变量和数据结构的注释 31 4.6 注释与注释内容不要空行 31 4.7 注释与注释内容保持一致的缩进 31 4.8 注释风格尽量统一 32 5 其它 33 5.1 代码走读 33 5.2 代码审查 33 5.2.1 代码调试开关 33 5.2.2 调试代码 33 5.3 代码维护 33 5.3.1 上传SVN 33 5.3.2 代码版本记录 33 5.3.3 代码相关文档 35 5.3.4 第三方资料备份 35 变更记录 更改页码 更改内容 更改人 /日期 批准人 /日期 简介 目的 编码规范是 范围和说明 本规范的主要适用范围为MFC和ACE类库的C++项目，项目所开发的代码必须遵守本规范中的约定，程序引用的中间件或其它类库可以与本规范不同。规范作为代码走查的标准，应当严格遵守。 对于同一个项目中的文件，应该遵守相同的规范，便于了解项目的功能和结构。对于同时使用MFC和ACE的项目可以由编码人员自行选择遵守MFC或ACE规范，甚至不同文件可以有不同的差异。但应当严格禁止在同一个文件中出现不同的风格。 注释风格采用Doxygen风格的注释，便于自动生成文档。 文档中的编码规范强制性规则使用黑色，建议性规则使用色。 API ：应用程序编程接口 UI用户界面 GUI图形用户界面 Google C++ style Guide。 ACE Software Development Guidelines。 Doxygen_manual_1.4.6。 《高质量C++编程指南》林锐 《C++编程规范_101条规则、准则与最佳实践》 文件 格式 行长度 每一行代码字符数原则上不超过80，最长不超过100个字符，除以下特殊情况。 1) 如果一行注释包含了超过80字符的命令或URL，出于复制粘贴的方便可以超过80字符； 2) 包含长路径的可以超出80列，尽量避免； 3) 头文件保护（防止重复包含）可以无视该原则。 行缩进 使用空格进行缩进，不要在代码中使用tabs，设定编辑器将tab转为空格。 一个制表符4个半空格符4个半空格符4个半空格符 指针和引用表达式 句点（.）或箭头（->）前后不要有空格，指针/地址操作符（*、&）后不要有空格。 在声明指针变量或参数时，星号与类型或变量名紧挨都可以同一个文件（新建或现有）中起码要保持一致。变量紧挨的方式。 类/结构 结构体和类（truct、classe）仅当只有数据时使用struct，其它一概使用class。 在C++中，关键字struct和class几乎含义等同， 默认继承权限。如果不明确指定，来自class的继承按照private继承处理，来自struct的继承按照public继承处理； 成员的默认访问权限。class的成员默认是private权限，struct默认是public权限。 　　除了这两点，class和struct基本就是一个东西。语法上没有任何其它区别。 struct被用在仅包含数据的消极对象（passive objects）上，可能包括有关联的常量，但没有存取数据成员之外的函数功能，而存取功能通过直接访问实现而无需方法调用，这儿提到的方法是指只用于处理数据成员的，如构造函数、析构函数、Initialize()、Reset()、Validate()。 如果需要更多的函数功能，class更适合，如果不确定的话，直接使用class。 如果与STL结合，对于仿函数（functors）和特性（traits）可以不用class而是使用struct。 类是C++中最重要也是使用频率最高的新特性之一。类的版式好坏将极大地影响代码品质。 注释