编程规范及要求.docxVIP

C++编码规范及要求 王卓 2008-02-21 版本 第一次编写 有关C、C++的编码风格和程序质量可以参照《咼质量 C/C++编程》 概述 错误 ! 未定义书签。 字体及颜色 . 错误 ! 未定义书签。 文件结构 . 错误 ! 未定义书签。 文件头注释 . 错误 !未定义书签。 头文件 . 错误 !未定义书签。 实现文件 . 错误 !未定义书签。 文件的组织结构 . 错误 !未定义书签。 命名规则 . 错误 ! 未定义书签。 类/结构. 错误!未定义书签。 函数. 错误!未定义书签。 变量 . 错误 ! 未定义书签。 常量. 错误!未定义书签。 枚举、联合、 typedef . 错误 ! 未定义书签。 宏、枚举值 . 错误 !未定义书签。 名空间 . 错误 ! 未定义书签。 代码风格与版式 . 错误 ! 未定义书签。 类/结构. 错误!未定义书签。 函数. 错误!未定义书签。 变量、常量 . 错误 !未定义书签。 枚举、联合、 typedef . 错误 ! 未定义书签。 宏 错误 !未定义书签。 名空间 . 错误 ! 未定义书签。 异常 . 错误 ! 未定义书签。 1概述 高品质、易维护的软件开发离不开清晰严格的编码规范。 本文档详细描述C++软件开发过程中的编码规范。 本规范也适用于所有在文档中出现的源码。 2字体及颜色 强烈推荐采用 Visual Assist X作为Visual Studio的辅助工具。在编辑源码时，应该 根据编辑器支持的自定义选项最大限度地满足下表定义的高亮规范。 类型 颜色 举例 注释 RO; G128; B0 （深绿） ■ 类、结构、联合、 枚举 ■ RO; GO; B255 （蓝） class CMyClass, enum ERRTYPE, typedef int CODE ... 名空间 RO; GO; B255 （蓝） n amespace BaiY 数字 R255; GQ BO （红） O12 119u Oxff ... 字符、字符串 ■ RO; G128; B128 （深蓝绿） string, c ... 宏定义、枚举值 1 1 R255;G128B0 （橙黄） #define UNICODE enum { RED GREEJNBLUE }; 操作符 R136; GQ B0 （棕色） ，=+ - * / ; { }（）[]... 方法/函数 R136; GQ BQ （棕色） MyFu nc（） 变量 1^^ R128; G128 B128 （中灰色） int nMyVar; 背景 1 R255; G255 B255 （白色） 其它 RO;GO;BO （黑色） other thi ngs （通常是一个错误） Windows平台中，应该优先使用字体： Fixedsys，这也是操作系统 UI （所有的菜单、按 钮、标题栏、对话框等等）默认使用的字体。该字体的好处很多： 1、 兼容性好：所有 Win dows平台都支持该字体 2、 显示清晰：该字体为点阵字体，相对于矢量字体来说在显示器中呈现的影像更为清晰。 矢量字体虽然可以自由缩放，但这个功能对于纯文本格式的程序源码来说没有任何实际作 用。而且当显示字号较小（12pt以下）时，矢量字体还有一些明显的缺陷： 文字的边缘会有严重的凹凸感。 一些笔画的比例也会失调。 开启了柔化字体边缘后，还会使文字显得模糊不清。 3、支持多语言：Fixedsys是UNICODE字体，支持世界上几乎所有的文字符号。这对编写中 文注释是很方便的。 3文件结构 文件头注释 所有C++勺源文件均必须包含一个规范的文件头，文件头包含了该文件的名称、功能概 述、作者、版权和版本历史信息等内容。标准文件头的格式为: /*! @file ******************************************************************************* PRE 模块名 ： 模块名 ：＜ 文件所属的模块名称＞ 文件名 ： ＜ 文件名＞ 相关文件 ：＜与此文件相关的其它文件 相关文件 ：＜ 与此文件相关的其它文件 ＞ 文件实现功能 : ＜描述该文件实现的主要功能 作者 ： ＜ 作者部门和姓名＞ 版本 ： ＜ 当前版本号＞ 备注 ： ＜ 其它说明＞ 修改记录： 日期 版本 修改人 修改内容 YYYY/MM/DD 作者或修改者名 修改内容 /PRE **************************************************************************** 如果该文件有其它需要说明的地方，还可以专门为此