CC++语言编程规范.doc

C/C++语言编程规范 文件状态： [ ] 草稿 [ ] 正在修改 [ ] 正式发布 文件标识： XXX 当前版本： 作 者： 完成日期： 文档控制 文档更新记录 日期 更新人 版本 备注 文档审核记录 日期 审核人 职务 备注 文档发行范围 分发单位 说明 目录 1.引言 5 1.1编写目的 5 1.2内容 5 1.3预期读者 5 1.4参考资料 5 1.4缩写和术语 5 2．命名规则 6 3．文件组织 8 3.1 头文件的结构 8 3.2 内部包含卫哨 8 3.3 源文件的结构 8 3.4 头文件包含顺序 9 3.5 外部包含卫哨 9 3.6 目录结构 10 3.7 其它原则 10 4．代码版式 11 4.1 空行 11 4.2 代码行 11 4.3 代码行内的空格 12 4.4 对齐与缩进 12 4.5 长行拆分 13 4.6 修饰符的位置 14 4.7 注释风格 14 5 编程规则和建议 16 5.1 表达式 16 5.2 声明和定义 17 5.3 整数数据类型及操作 17 5.4 字符操作 18 5.5 浮点型 18 5.6 常量 19 5.7 指针 19 5.8 数组 20 5.9 函数 20 5.10 控制语句 21 5.11 内存使用 21 5.12 错误处理 21 5.13 断言 21 5.14 类 22 5.15 结构成员对齐方式 22 5.16 连接规范 24 5.17 函数调用规范 25 5.18 通用规则和建议 25 6．附件 27 6.1 头文件样式模板 27 6.2 源文件样式模板 27 6.3 函数头注释模版 28 1.引言 1.1编写目的 本文档的目的是为XXX公司使用C/C++语言进行软件开发提供编程规范指南。 声明： 本规范针对的C++语言是指ISO/IEC 14882:1998标准规定的C++语言规范。 本规范对编程过程中使用的第三方程序库不做任何假设，第三方程序库仍然保留其固有的编程风格和规范。 规则0：不存在绝对的编程规范和规则；规范和规则不应有正确与错误之分，只有适合与不适合、好与不好或者通用与不通用的区别。规范和规则强调的是一致性，这个一致性有三层含义：①每个开发人员编写的代码要前后一致；②每个项目组采用统一的编程规范；③全公司各项目组都采用统一的编程规范。 1.2内容 编程规范不仅仅包含编程风格，更重要的是指导如何正确运用语言提供的机制，提供常用的惯用法，改善编程效率和程序性能的方法和技巧，以及编程的禁区。大部分的内容可以用“规则”或“规范”的形式固定下来，但是也有很多内容只能以“建议”的形式呈现。 1.3预期读者 本文档的主要读者包括： 开发设计人员和程序员 项目管理员 软件质量保证人员 1.4参考资料 [1] Coding Standards for C, C++, and Java [2] Recommended C Style and Coding Standards [3] C/C++ Programming Style Guidelines [4] C++编程规范：101条规则、准则和最佳实践 1.5缩写和术语 标识符（identifier） 指C/C++中的一个变量、常量、宏、函数或类型的名字 定义（define） 提供一个程序元素或实体在程序中的唯一描述 声明（declare） 把一个名字引入一个程序或者一个作用域，以向编译器表明该名字的存在性及其作用域 作用域（scope） 一个名字可以被引用的程序范围。C++有6种作用域：全局，文件，程序块，函数体，函数原型，类，名字空间 编译单元 源文件及其递归包含的所有头文件共同编译生成的目标模块(.obj/.o)，一个源文件是一个最小的编译单元 2．命名规则 类别 规则 示例 共性规则 所有标识符的名字应当直观且可以顺利拼读，可望文生义，不必进行解码（即自说明的，几乎不需要专门的注释）； 同一个作用域中不要出现仅靠大小写来区分的相似标识符，虽然C/C++是大小写相关的； 在设计中，所有模块(namespace)、函数、变量、宏、类型等的名称均由字母、数字和单下划线组成，尽量少使用数字（除非语义如此），标识符的头部和尾部一般不要使用下划线和数字； 所有的名称均应具有实际含义，应体现实际用途，不应该包含那些不被普遍接受和认同的缩略语； 尽量不要出现局部变量和全局变量同名的现象，虽然两者作用域不同而不会发生语法错误，但是会使人误解