C++编程规范及要求.doc

《C++编程规范及要求.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、C++编码规范及要求王卓2008-02-21版本V1.0第一次编写有关C、C++的编码风格和程序质量可以参照《高质量C/C++编程》1概述32字体及颜色33文件结构43.1文件头注释43.2头文件113.3实现文件133.4文件的组织结构144命名规则154.1类/结构164.2函数164.3变量174.4常量184.5枚举、联合、typedef184.6宏、枚举值184.7名空间185代码风格与版式195.1类/结构225.2函数285.3变量、常量375.4枚举、联合、typedef395.5宏405.6名空间405.7异常411概述

2、高品质、易维护的软件开发离不开清晰严格的编码规范。本文档详细描述C++软件开发过程中的编码规范。本规范也适用于所有在文档中出现的源码。2字体及颜色强烈推荐采用VisualAssistX作为VisualStudio的辅助工具。在编辑源码时，应该根据编辑器支持的自定义选项最大限度地满足下表定义的高亮规范。类型颜色举例注释R0;G128;B0（深绿）//注释例子关键字R0;G0;B255（蓝）typedef,int,dynamic_castclass...类、结构、联合、枚举R0;G0;B255（蓝）classCMyClass,enumERRT

3、YPE,typedefintCODE...名空间R0;G0;B255（蓝）namespaceBaiY数字R255;G0;B0（红）012119u0xff...字符、字符串R0;G128;B128（深蓝绿）"string",'c...宏定义、枚举值R255;G128;B0（橙黄）#defineUNICODE,enum{RED,GREEN,BLUE};操作符R136;G0;B0（棕色）<>,=+-*/;{}()[]...方法/函数R136;G0;B0（棕色）MyFunc()变量R128;G128;B128（中灰色）intnMyVar;背景R2

4、55;G255;B255（白色）其它R0;G0;B0（黑色）otherthings（通常是一个错误）Windows平台中，应该优先使用字体：Fixedsys，这也是操作系统UI（所有的菜单、按钮、标题栏、对话框等等）默认使用的字体。该字体的好处很多：1、兼容性好：所有Windows平台都支持该字体2、显示清晰：该字体为点阵字体，相对于矢量字体来说在显示器中呈现的影像更为清晰。矢量字体虽然可以自由缩放，但这个功能对于纯文本格式的程序源码来说没有任何实际作用。而且当显示字号较小（12pt以下）时，矢量字体还有一些明显的缺陷：l文字的边缘会有严

5、重的凹凸感。l一些笔画的比例也会失调。l开启了柔化字体边缘后，还会使文字显得模糊不清。3、支持多语言：Fixedsys是UNICODE字体，支持世界上几乎所有的文字符号。这对编写中文注释是很方便的。1文件结构1.1文件头注释所有C++的源文件均必须包含一个规范的文件头，文件头包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。标准文件头的格式为：/*!@file*******************************************************************************

模
6、块名:<文件所属的模块名称>文件名:<文件名>相关文件:<与此文件相关的其它文件>文件实现功能:<描述该文件实现的主要功能>作者:<作者部门和姓名>版本:<当前版本号>--------------------------------------------------------------------------------备注:<其它说明>--------------------------------------------------------------------------------修改记录:日期版本修改人修改内容YYY
7、Y/MM/DDX.Y<作者或修改者名><修改内容>

模块名:<文件所属的模块名称>文件名:<文件名>相关文件:<与此文件相关的其它文件>
8、文件实现功能:<描述该文件实现的主要功能>作者:<作者部门和姓名>版本:<当前版本号>-----------------------------------------------------