常见C/C++编码规范(3)

 

2.2 命名 
本文列出Visual C++的标识符命名规范。 

<规则 1> 标识符缩写 
形成缩写的几种技术： 
1) 去掉所有的不在词头的元音字母。如screen写成scrn, primtive写成prmv。 
2) 使用每个单词的头一个或几个字母。如Channel Activation写成ChanActiv,Release Indication写成RelInd。 
3) 使用变量名中每个有典型意义的单词。如Count of Failure写成FailCnt。 
4) 去掉无用的单词后缀 ing, ed等。如Paging Request写成PagReq。 
5) 使用标准的或惯用的缩写形式（包括协议文件中出现的缩写形式）。如BSIC(Base Station Identification Code)、MAP(Mobile Application Part)。 

关于缩写的准则： 
1) 缩写应该保持一致性。如Channel不要有时缩写成Chan,有时缩写成Ch。Length有时缩写成Len,有时缩写成len。 
2) 在源头部加入注解来说明协议相关的、非通用缩写。 
3) 标识符的长度不超过32个字符。 
<规则2> 变量命名约定 
参照匈牙利记法,即 
[作用范围域前缀] + [前缀] + 基本类型 + 变量名 
其中： 
前缀是可选项,以小写字母表示; 
基本类型是必选项,以小写字母表示; 
变量名是必选项,可多个单词(或缩写)合在一起,每个单词首字母大写。 
前缀列表如下： 
前缀 意义 举例 
g_ Global 全局变量 g_MyVar 
m_ 类成员变量 或 模块级变量 m_ListBox, m_Size 
s_ static 静态变量 s_Count 
h Handle 句柄 hWnd 
p Pointer 指针 pTheWord 
lp Long Point 长指针 lpCmd 
a Array 数组 aErr 
基本类型列表如下： 
基本类型 意义 举例 
b Boolean 布尔 bIsOK 
by Byte 字节 byNum 
c Char 字符 cMyChar 
i或n Intger 整数 nTestNumber 
u Unsigned integer 无符号整数 uCount 
ul Unsigned Long 无符号长整数 ulTime 
w Word 字 wPara 
dw Double Word 双字 dwPara 
l Long 长型 lPara 
f Float 浮点数 fTotal 
s String 字符串 sTemp 
sz NULL结束的字符串 szTrees 
fn Funtion 函数 fnAdd 
enm 枚举型 enmDays 
x,y x,y坐标 

<规则3> 宏和常量的命名