VC编程规范文档-NEW.docVIP

VC编程规范 ?1. 基本要求 1.1 程序结构清析，单个函数的程序行数不得超过00行。1. 尽量使用标准库函数和公共函数。1. 不要随意定义全局变量，尽量使用局部变量。1.使用括号以避免二义性。 2. 可读性要求2.1 保持注释与代码完全一致。2. 每个源程序文件，都有文件头说明，说明规格见。2. 每个函数，都有函数头说明，说明规格见。2. 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。2. 常量定义（DEFINE）有相应说明。2. 处理过程的每个阶段都有相关注释说明。2. 在典型算法前都有注释。2. 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 6个字节。2. 循环、分支层次不要超过五层。2.1 注释可以与语句在同一行，也可以在上行。2.1 空行和空白字符也是一种特殊注释。2.1的语句不加注释。2.1 注释的作用范围可以为：定义、引用、条件分支以及一段代码。 3. 结构化要求 3.1 禁止出现两条等价的支路。3.2 禁止GOTO语句。3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。3.4 用 CASE 实现多路分支。3.5 避免从循环引出多个出口。3.6 函数只有一个出口。3.7 不使用条件赋值语句。3.8 避免不必要的分支。 4. 正确性与容错性要求 4. 改错误前首先考虑对其它的影响。4. 所有变量在调用前必须被初始化。4. 对所有的用户输入，必须进行合法性检查。4. 不要比较浮点数的相等，如： 10.0 * 0.1 == 1.0 ， 4.6 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。 5. 可重用性要求5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。5.2 公共控件或类应减少外界联系，考虑独立性或封装性。5.3 公共控件或类应建立使用模板。.命名要求 6.1 变量命名 命名必须具有一定的实际意义,形式为xAbcFgh,x,Abc、Fgh表示连续意义字符串,如果连续意义字符串仅两个,都大写如OK例: 类型 前缀 实例 char ch chGrade TCHAR ch chName BOOL b bEnable int n nLength UINT n nHeight WORD w wPos LONG l lOffset DWORD dw dwRange * p pDoc LPSTR lpsz lpszName LPCSTR lpsz lpszName LPCTSTR lpsz lpszName handle h hWnd callback lpfn m_ 与界面相关联的类成员变量 m_nVal, m_bFlagg_ 全局变量 g_nMsg, g_bFlag ,j,m,n一般用于循环变量。 .2常量命名和宏定义 常量和宏定义必须具有一定的实际意义; 常量和宏定义在#include和函数定义之间; 常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用; 资源名字定义格式: 前缀 符号类型 IDR_ 不同类型的多个资源共享标识 IDD_ 对话框资源 HIDD_ 对话框资源的Help上下文 IDB_ 位图资源 IDC_ 光标资源 IDI_ 图标资源 ID_ 来自菜单项或工具栏的命令 HID_ 命令Help上下文 IDP_ 消息框提示 HIDP_ 消息框Help上下文 IDS_ 串资源 IDC_ 对话框内的控件 .3函数命名 函数原型说明包括引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名, 如是内部函数，只要注释其定义文件名; 第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,示例如下： void ShowChar (int , int nY); void ImportantPoint(); void ImportPoint(); 6.4结构体命名 结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用大小写字母组合，第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区，必须注明其所属的进程。全局数据定义只需注意其用途。 示例： typedef struct { char szProductName[20]; char szAuthor[20]; char szReleaseDate[16]; char szVersion[10]; unsigned long MaxTables;