C++编码规范与指导1.25.docVIP

C++编码规范与指导 目录 版权声明 概述 语法高亮与字体 字体 语法高亮 文件结构 文件头注释 头文件 内联函数定义文件 实现文件 文件的组织结构 命名规则 类/结构 函数 变量 常量 枚举、联合、typedef 宏、枚举值 名空间 代码风格与版式 类/结构 函数 变量、常量 枚举、联合、typedef 宏 名空间 异常 修改标记 版本控制 自动工具与文档生成 英文版 关于本规范的贯彻实施 术语表 参考文献 C++成长篇 与我联系 附件 常用注释一览 常用英文注释一览 文件头例子 头文件例子 实现文件例 内联函数定义文件例子 类/结构的风格与版式例子 函数的风格与版式例子 RTTI、虚函数和虚基类的开销分析和使用指导 C++异常机制的实现方式和开销分析 版权声明 本文档版权归作者所有。您可以以任意形式免费使用本文档的任意部分，并且无需通知作者。作者对使用本文档所造成的任何直接或者间接的损失不负任何责任。 概述 对于任何工程项目来说，统一的施工标准都是保证工程质量的重要因素。堪称当今人类最抽象、最复杂的工程——软件工程，自然更加不能例外。 高品质、易维护的软件开发离不开清晰严格的编码规范。本文档详细描述C++软件开发过程中的编码规范。本规范也适用于所有在文档中出现的源码。 除了“语法高亮”部分，本文档中的编码规范都以： 规则（或建议） 解释 的格式给出，其中强制性规则使用黑色，建议性规则使用灰色。 语法高亮与字体字体文字是信息的载体；文字使我们能够把个人的经验和思想长久的保存下来；文字使我们得以站在前人的肩膀上向前发展；文字的诞生标志着人类文明的开始…… 扯的太离谱了？好吧，至少你应该承认： 没有文字就不可能出现计算机（先不管他是哪国字） 没有文字大家就不可能（也没必要）学会如何写程序 在过去、现在和可见的将来，使用文字符号都是编写计算机软件的主要方式方法 既然文字如此重要，它的长相自然会受到广泛的关注。如今这个连MM都可以“千面”的年头，字体的种类当然是数不胜数。 然而，前辈先贤们曾经用篆体教导偶们：。想让大家读到缩进、对齐正确一致，而且不出现乱码的源文件，我们就要使用相互兼容的字体。 字体规范如下： 使用等宽字体 由于非等宽字体在对齐等方面问题多多，任何情况下，源码都必须使用等宽字体编辑和显示。 　 每个制表符（TAB）的宽度为4个半角字符 不一致的缩进宽度会导致行与行之间的参差不齐，进而严重影响代码的可读性。 　 优先使用Fixedsys 在Windows平台中，应该优先使用字体：Fixedsys，这也是操作系统UI（所有的菜单、按钮、标题栏、对话框等等）默认使用的字体。该字体的好处很多： 兼容性好：所有Windows平台都支持该字体　 显示清晰：该字体为点阵字体，相对于矢量字体来说在显示器中呈现的影像更为清晰。矢量字体虽然可以自由缩放，但这个功能对于纯文本格式的程序源码来说没有任何实际作用。而且当显示字号较小（12pt以下）时，矢量字体还有一些明显的缺陷：　 文字的边缘会有严重的凹凸感。 一些笔画的比例也会失调。 开启了柔化字体边缘后，还会使文字显得模糊不清。 说句题外话，这也是Gnome和KDE等其它GUI环境不如Windows的一个重要方面。支持多语言：Fixedsys是UNICODE字体，支持世界上几乎所有的文字符号。这对编写中文注释是很方便的。 语法高亮几乎所有的现代源码编辑器均不同在程度上支持语法高亮显示的功能。缤纷的色彩不但可以吸引MM们的目光，还可以在很大程度上帮助我们阅读那些奥涩如咒语般的源代码。 统一的语法高亮规则不仅能让我们望色生意，还可以帮助我们阅读没有编码规范，或者规范执行很烂的源码。 所有在文档中出现的代码段均必须严格符合下表定义的语法高亮规范。在编辑源码时，应该根据编辑器支持的自定义选项最大限度地满足下表定义的高亮规范。 类型 颜色 举例 注释 R0;G128;B0（深绿） // 注释例子 关键字 R0;G0;B255（蓝） typedef, int, dynamic_cast class ... 类、结构、联合、枚举等其它自定义类型 R0;G0;B255（蓝） class CMyClass, enum ERRTYPE, typedef int CODE ... 名空间 R0;G0;B255（蓝） namespace BaiY 数字 R255;G0;B0（红） 012 119u 0xff ... 字符、字符串 R0;G128;B128（深蓝绿） string, c ... 宏定义、枚举值 R255;G128;B0（橙黄） #define UNICODE, enum { RED, GREEN, BLUE }; 操作符 R136