VC编程规范[转贴+修改](草稿)
一、适用范围
本标准适用于利用Visual C++，Borland C++进行软件程序开发的人员；利用Delphi进行软件开发的人员，可作相应的参考。
二、基本原则
2.1 基本要求
1. 程序结构清晰，简单易懂，单个函数的程序行数不得超过100行。
2. 打算干什么，要简单，直截了当，代码精简，避免垃圾程序。
3. 尽量使用标准库函数和公共函数。
4. 不要随意定义全局变量，尽量使用局部变量。
5. 使用括号以避免二义性。
2.2 可读性要求
1. 可读性第一，效率第二。
2. 保持注释与代码完全一致。
3. 每个源程序文件，都有文件头说明，说明规格见规范。
4. 每个函数，都有函数头说明，说明规格见规范。
5. 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。
6. 常量定义（define）有相应说明。
7. 处理过程的每个阶段都有相关注释说明。
8. 在典型算法前都有注释。
9. 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节。
10. 循环、分支层次不要超过五层。
11. 注释可以与语句在同一行，也可以在上行。
12. 空行和空白字符也是一种特殊注释。
13. 一目了然的语句不加注释。
14. 注释的作用范围可以为：定义、引用、条件分支以及一段代码。
15. 注释行数(不包括程序头和函数头说明部份)应占总行数的 1/5 到 1/3 。
2.3 结构化要求
1. 禁止出现两条等价的支路。
2. 禁止GOTO语句。
3. 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
4. 用 CASE 实现多路分支。
5. 避免从循环引出多个出口。
6. 函数只有一个出口。
7. 不使用条件赋值语句。
8. 避免不必要的分支。
9. 不要轻易用条件分支去替换逻辑表达式。
2.4 正确性与容错性要求
1. 程序首先是正确，其次是优美
2. 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。
3. 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。
4. 所有变量在调用前必须被初始化。
5. 对所有的用户输入，必须进行合法性检查。
6. 不要比较浮点数的相等，
如： 10.0 * 0.1 == 1.0 ， 不可靠。
7. 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。
8. 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。
9. 与常量比较时，将常量放在左边。防止当少输入一个“=”时，带来的逻辑错误。
如：if(NULL==lpData)
2.5 可重用性要求
1. 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
2. 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。
3. 公共控件或类应建立使用模板。
三、如何注释
原则上注释要求使用中文。注释与代码行数比约为1/3~1/5。
3.1单行注释
单行注释放在注释行末，采用//就可以了，即使注释的内容很长，也不要使用/* */进行注释，只是分行采用//注释；如果上下行都有注释，则可以用TAB上下对齐。
例如：
int index； //索引序号
ResetSrcollInfo(g_hwndThumb)；//初始化滚动条位置
InitPicLib(g_szModuleName)； //初始化图像接口
3.2函数注释
函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等，复杂的函数需要加上变量用途说明。
例如：
/******************************************************************************
*函数名：HandleWriteData(LPOVERLAPPED, LPCSTR, DWORD)
*目 的：向一个COMM文件句柄(FILE HANDLE)写入一个字符串
*参 数：
* lpOverlappedWrite – 在WriteFile函数种需要用到的重叠结构
* lpszStringToWrite – 待写入的串
* dwNumberOfBytesToWrite – 待写入的串的长度
*返回值：
* TRUE -- 如果所有的字节都被成功写入。
* FALSE -- 如果非整个传成功写入。
*描 述：
* 此函数为写线程服务的一个帮助函数。实际上是写入一个串到comm file。注
* 意此函数将会是阻塞式的，它一直等待写入完成或CloseEvent去通知线程结
* 束。另外一个返回FALSE的情况是comm port本身是关闭的。
*作 者：
*日 期：
*修 改：
*日 期：
*版 本：
******************************************************************************/
3.3 语句块的注释
一块语句的注释类是与一个函数的注释，但不同于函数注释的是块的注释必须用TAB居中对齐，如下：
/**************************************************************************
* 下面的代码是用来接收网络数据
**************************************************************************/
3.4文件注释
程序中注释包括：修改时间和作者、方便理解的注释等。
文件开始注释内容包括：公司名称、版权、作者名称、时间、模块用途、背景介绍等，复杂的算法需要加上流程说明。
例如：
/******************************************************************
*文件名：
* Copyright (c) 2001-2005 *********公司技术开发部
*创建人：
*日 期：
*修改人：
*日 期：
*描 述：
*版 本：
******************************************************************/
3.5常量和宏注释
四、命名规范
4.1变量定义
4.1.1 变量命名
命名必须具有一定的实际意义，做到“看名知义”—看到变量名称可以知道变量的类型及其含义。
变量命名格式要求为：[限定范围的前缀] + [数据类型前缀] + 有意义的名称。
Ø 限定范围的前缀
| 前缀
|
说明
|
实例
|
备注
|
| g_ |
全局变量 |
g_bFlag；g_nMsg,
|
|
| m_ |
类成员变量 |
m_nVal；m_bFlag
|
|
| s_ |
静态变量 |
s_nNum；s_nCount |
|
| l_ |
局部变量 |
l_nTmp；l_strDes |
一般不需要使用
|
Ø 数据类型前缀
| 分类
|
类型
|
说明
|
具体例程
|
备注
|
| 标准 |
b |
BOOL |
bEnable |
|
| ch |
char |
chText |
|
|
| w |
WORD |
wTmp |
|
|
| dw |
DWORD |
dwStart |
|
|
| x,y |
坐标 |
|
|
|
| i |
int |
nCmdShow |
|
|
| l |
LONG |
lParam |
|
|
| u |
UINT |
uNotify |
|
|
| f |
float |
fTmp |
|
|
|
|
|
|
|
|
| Windows |
wParam |
WPARAM |
wParam |
|
| lParam |
LPARAM |
lParam |
|
|
| lp |
LPVOID |
lpReserved |
|
|
| lpsz |
LPTSTR |
lpszClassName |
|
|
| lp |
LPSTR |
lpCmdLine |
|
|
| psz |
PSTR |
pszTip |
|
|
| h |
HWND |
hDlg |
|
|
| h |
HDC |
hDC |
|
|
| h |
HINSTANCE |
hInstance |
|
|
| h |
HANDLE |
hInstance |
|
|
| h |
HICON |
hIcon |
|
|
|
|
|
string
|
str * |
|
|
|
|
AnsiString
|
str * |
|
Ø 有意义的名称：可以是一个单词或者多个单词的组合，每个单词开头一个字母大写。
Ø 循环变量可以直接定义成i，j，k，l等一个字母，大小写不限。
Ø 计算变量：Counter，Count，Cnt等。
Ø 返回值：Ret，Result。
Ø 位置变量：xPos，yPos等。
Ø 用Width，Height，Wide等表示宽高的含义的变量。
4.1.2 变量定义的地方规定
变量定义不一定定义在函数块的变量定义区，但必须在它所在块的变量定义区，即在它的所处理代码之前定义。
错误的使用方法如下：
main()
{
//块的开始，变量应该在块的开始的变量区定义。
//变量定义
int i = 1;
printf(“print i = %d/n”,i);
//此变量应该在块的开头，也即变量定义区定义。
int j = 2;
printf(“print j = %d/n”,j);
}
上述代码书写造成了块中的变量和代码混在一起，正确的方法应该是把变量定义定义在变量区，把代码处理写在代码区，从而使块中的变量和代码分离。如下为正确的使用方法。
函数
{//块的开始
//在块的开始定义变量
//变量定义区
int i = 1;
//代码处理区
printf(“print i = %d/n”,i);
for循环
{//块的开始
//在块的开始定义变量
//变量定义区
int j;
...
//代码处理区
printf(“print j = %d/n”,j);
...
}//块的结束
}//块的结束
4.1.3 变量的对齐
变量数据类型 + N个TAB + 变量名 + [N个TAB] + = + [初始值] + ；
其中，“变量数据类型”与“变量名”之间的[N个TAB]中之间的N直到后面变量名垂直对齐为止的值，其值必须大于1；后面的[N个TAB]中的N的取值可等于0，但建议也使后面的初始化的值按TAB值垂直对齐，
例如：
int nFullPicWidth = 0；
int nFullPicHeight = 0；
LPINT lpWidthIndex = NULL；
LPINT lpHeightIndex = NULL；
LPDIB lpOriginDib = NULL；
LPDIB lpScaleDib = NULL；
RECT rcViewRect = [0，0，0，0]；
POINT posOrigin = [0，0]；
SCALERECT rcScale;
int x，y；
int X，Y；
int l；
4.2 常量和宏命名
常量和宏定义必须具有一定的实际意义；
常量和宏定义在#include和函数定义之间；
常量和宏定义必须全部以大写字母来撰写，中间可根据意义的连续性用下划线连接，每一条定义的右侧必须有一简单的注释，说明其作用；
资源名字定义格式:
菜单：IDM_XX或者CM_XX
位图：IDB_XX
对话框：IDD_XX
字符串：IDS_XX
DLGINIT：DIALOG_XX
ICON：IDR_XX
4.3 结构体和联合体命名
结构体类型和联合体命名必须全部用大写字母，原则上前面以下划线开始；结构体和联合体变量命名必须用大小写字母组合，第一个字母必须使用大写字母，必要时可用下划线间隔。对于私有数据区，必须注明其所属的进程。全局数据定义只需注意其用途。
示例如下：
typedef struct
{
char szProductName[20];
char szAuthor[20];
char szReleaseDate[16];
char szVersion[10];
unsigned long MaxTables;
unsigned long UsedTables;
}DBS_DATABASE;
DBS_DATABASE GdataBase;
4.4 函数命名
函数原型说明包括引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模
块名及文件名, 如是内部函数，只要注释其定义文件名；第一个字母必须使用大写字母,要求用大小写字母组合规范函数命名,必要时可用下划线间隔，示例如下：
void UpdateDB_Tfgd (TRACK_NAME)；//Module Name :r01/sdw.c
void PrintTrackData (TRACK_NAME)； //Module Name :r04/tern.c
void ImportantPoint (void)； //Module Name :r01/sdw.c
void ShowChar (int , int , chtype)； //Local Module
void ScrollUp_V (int , int)； //Local Module
4.5 控件命名
用小写前缀表示类别
| 类型
|
省写
|
说明
|
| Form |
fm |
窗口 |
| Button |
btn |
按钮 |
| combox |
cob
|
组合式列表框 |
| Text |
txt |
文本输入框 |
| label |
lbl |
标签 |
| image |
img |
图像 |
| picture |
pic |
图像 |
| Grid |
grd |
网格 |
| Scroll |
scr |
滚动条 |
| ListBox |
lst |
列表框 |
| frame
|
frm
|
|
控件对象命名：控件类型 + 控件描述
五、格式要求
{}必须对齐。
5.1 判断结构
5.2 循环结构
5.3
六、程序
a. 程序编码力求简洁，结构清晰，避免太多的分支结构及太过于技巧性的程序，尽量不采用递归模式。
b. 编写程序时，亦必须想好测试的方法，换句话说，”单元测试” 的测试方案应在程序编写时一并拟好。
c. 注释一定要与程序一致。
d. 版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要在文件及函数的修改记录中加以记录。
e. 程序中每个block 的开头 “{" 及 "}” 必须对齐，嵌套的block 每进一套，缩进一个tab，TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。
f. 对于比较大的函数，每个block 和特殊的函数调用，都必须注明其功能，举例如下：
count.divisor = 1193280 / freq; // compute the proper count
OutByte((unsigned short)67, (unsigned char)182); // tell 8253 that a count is coming
OutByte((unsigned short)66, count. c[0]); // send low-order byte
OutByte((unsigned short)66, count. c[1]); // send high-order byte