C++ 编码规范【DOC精选】.docVIP

C++ 编码规范 C++ Coding Standard 编制单位：新太科技技术开发中心SEPG 编制时间：2003/5/10 文档编号：SPMS-SEP-10 版 本 号：1.0 编制 审核 批准 生效日期 变更记录 A - ADDED M - MODIFIED D - DELETED 序号 日期 章节号 A/M/D 变更简述 变更人 0.0a Initial Draft 初稿 吴传兵 0.0b Modified after references to Infosys standard 参考Infosys的标准后的修改稿 吴传兵 0.99 2003-03-05 Modified after discussion in RD1 在开发一部内部讨论后的修改稿 RD1 1.0 2003-5-12 参考各位同事的意见，对编码规范进行了完善和修改。 修订记录： 1.头部注释部分，增加规则3的举例说明。 2.修改了一些例子描述，使之更符编码规范。 3.代码可读性部分，增加一项建议5：避免使用过于复杂的或多用途的复合表达式。 4.函数质量部分，增加规则10的举例说明。 5.其他规则部分，修改了对规则8的说明、建议1的表述。 6.函数的质量部分，增加建议2（参数书写）、建议3（常量使用）。 7.在类的实现构造函数部分，增加规则4：有指针类型成员变量的类，必须定义其拷贝构造函数和赋值函数。 8.文件扩展名部分，修改了规则1。 9.类的实现析构函数部分，修改了规则1。 10.其他一些描述性的修改 吴传兵 1.01 C++编码规范1.0颁布两周后进行一次全公司的C++代码规范性检查，根据检查发现的问题，对编码规范作了如下规定。 1.文件扩展名：修改规则1（模板类的头文件可包含实现代码）。 2.其他规则：增加对规则9（CString和string的比较）说明。 3.函数的质量：增加对规则3（关于使用goto语句）的说明；修改了规则7、规则10；增加了建议4。 5.排版格式：修改了规则5。 6.函数的质量：增加规则2的说明。 7.全局函数调用：增加对规则1的说明。 1.02 2003-5-29 4.2.1规则二 4.2.1规则四 4.2.2规则一 3.1.2规则一 3.5 规则五 A A A A A 增加C++ Builder例外说明 增加C++ Builder VCL类对于拷贝构造、赋值的例外 增加说明 增加对C++ Builder __property的说明 增加关于针对C++Builder控件命名的例外说明， 戴晴波 目 录 1. 目的 5 2. 说明 5 3. 命名规范 5 3.1 文件 5 3.2 常量与宏 6 3.3 函数 6 3.4 存储类型 7 3.5 变量 7 4. 类的定义 10 4.1 类的申明 10 4.2 类的实现 11 5. 文件格式 13 5.1 头部注释 13 5.2 排版格式 18 5.3 代码可读性 20 6. 函数实现 23 6.1 函数的注释 23 6.2 函数的质量 24 6.3 函数的效率 28 7. 其它规则 34 目的 避免常见错误，提高代码质量。 提高代码的可维护性。 提高代码的可读性。 说明 本规范作为一个标准的C＋＋编码规范，其中对于规则是必须遵守的，建议是提醒您需要注意的地方，或者是在该情况下一个较好的选择。 命名规范 文件 文件用途 头文件通常包含：const常量、＃define、类型定义、类申明、inline函数、全局函数申明以及其它程序需要的定义。 实现文件通常包含：类的实现、类的成员函数和全局函数的实现、静态成员实现。 规则1：同一个类（或一组类、一组函数）的头文件和实现文件，其文件名（不含扩展名的部分，下同）必须相同，以扩展名来区别。且文件名全部用小写字母。（单个类超过3000行才能按功能分成不同的实现文件） 说明：文件名要求全部小写主要是兼容不同的操作系统的需要。 示例：如日志类tlog，其头文件为：tlog.h，实现文件为：tlog.cpp。 规则2：通常，所有的实现文件必须有相应的头文件，但头文件不一定要求有相应的实现文件（如纯粹的常量定义、宏定义、类型定义等头文件）。 示例：CommMain中专门用来定义自定义类型的cttypes.h文件就没有相应的实现文件。 文件扩展名 规则1：C＋＋的实现文件命名.cpp，头文件命名.h。头文件中不允许包含任何类或函数的实现(单行实现的inline函数、模板类除外)。实现文件和相应的头文件其文件名必须相同。 示例：如日志类TLog，其头文件为：tlog.h，实现文件为：tlog.cpp。 说明：请审核者注意：C