VC.net编程规范.docVIP

编程规范 一、命名约定 变量的命名通常由两部分组成：以变量类型的缩写开头，通常是小写；后面是表示变量的含义的若干单词，单词的第一个字母大写，其余字母小写，单词之间不空格。 下表是常见类型的缩写，其它变量如类的实例变量、自定义类型（如结构、联合等），其类型的缩写为类名每个单词的第一个字母。 常见类型变量前缀命名规则一览表 序号 类 型 举例 1 整型变量(int) i int iCount 2 无符号整型变量(unsigned int) u unsigned int uLength 3 短整型变量(short) n short nCount 4 长整型变量(long) l long lSequenceNo 5 无符号长整型变量(unsigned long) ul unsigned long ulSize 6 浮点型(float) f float fWeight 7 双浮点型(double) d double dLength 8 字节变量(byte) by BYTE byBuffer 9 字变量(word) w WORD wSize 10 双字变量(dword) dw DWORD dwSize 11 字符变量(char) ch char chBuffer 12 字符串变量(cstring) str String strBuffer 13 布尔变量(boolean) b boolean bFlag 14 句柄变量(handle) h handle hDC,hWnd 15 枚举变量(enum) e enum eMonths 16 指针变量(*) p int *piCount 17 数组变量(array) a array of WORDs:awVar 说明： 1.如果是指向上述类型的指针，就在上面规范前加 p ; 2.如果是指向上述类型的双重指针，就在上面规范前加 pp ; 3.如果是类成员变量，则在上面规范前加 m_; 4.全局变量,则在上面规范前加 g_; 5.在类型前加了const,命名约定不变; VC中一些控件变量的前缀缩写： ComboBox cmb Edit edt Dialog dlg ListBox lst Picture pic Animate ani 二、变量定义规则 1.MFC类 CWnd* p...Wnd 省去的地方一般为该类的用途 (如果是某一个类的成员，则还应该在前加 m_)又如：CView* p...View 2.局部变量应尽量易懂简洁，使用常见的变量，如Num, nCount, i, j, k, n, len, pos, offset, nReadNum, index, nRet, ret, string, filename临时变量，如ltmp, ftmp,tmpStr,tempStr 函数命名也应该见名知意。如CalcAllDataStyle(),ReadDocDataFromTime(),GetIndexInfo()常见的函数Init, Open_, Create_, Get_, Set_, Read_, Load_, Write_, Start_, Stop_, Check_, Test_, Fill_, Process_, Sort_, Do_, Select_, Is_, Exist_,_Ex… 4.只对常用变量名和长变量名进行缩写 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用Cnt，而在另一些区域中又使用Count，就会给代码增加不必要的复杂性。 5. 禁止使用汉语拼音来命名； 6.在代码中尽量不用具体的大小数值，定义成，便于以后维护Const int MAX_DOWNLOADNUM=20 struct DownInfo m_DownInfo[MAX_DOWNLOADNUM]; 7.定义有焦点的变量 用于多个目的的变量称为无焦点（多焦点）的变量。无焦点变量所代表的意义与程序的执行流程有关，当程序处于不同位置时，它所表示的意义是不固定的，这样就给程序的可读性和可维护性带来了麻烦。 如： Int iCount; iCount=GetStudentCount(); …… iCount=GetTeacherCount(); 8.使用肯定形式的布尔变量 给布尔变量命名时，始终都要使用变量的肯定形式，以减少其它开发人员在理解布尔变量所代表的意义时的难度。 如： bool bSuccess; bool bFa