C语言命名规则

命名法则

目前，业界共有四种命名法则：驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法，其中前三种较为流行。

（1）驼峰命名法
驼峰命名法是指混合使用大小写字母来构成变量和函数的名字，函数名中的每一个逻辑断点都有一个大写字母来标记。
例如：printMessageName（）；
用途：驼峰命名法近年来越来越流行了，在许多新的函数库和Microsoft Windows这样的环境中，它使用得相当多。

(2)匈牙利命名法
匈牙利命名法通过在变量名前面加上相应的小写字母的符号标识作为前缀，标识出变量的作用域、类型等。这些符号可以多个同时使用，顺序是先m_(成员变量)、再指针、再简单数据类型、再其它。这样做的好处在于能增加程序的可读性，便于对程序的理解和维护。标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。
例如：iNameCount;
用途：广泛应用于像Microsoft Windows这样的环境中。Windows 编程中用到的变量(还包括宏)的命名规则为匈牙利命名法。

(3)帕斯卡(pascal)命名法
与驼峰命名法类似，二者的区别在于：驼峰命名法是首字母小写，而帕斯卡命名法是首字母大写。
例如：PrintMessageName（）；

(4) 下划线命名法
下划线命名法，是指混合使用大小写字母来构成变量和函数的名字。函数名中的每一个逻辑断点都有一个下划线来标记。下划线法是C出现后开始流行起来的，在许多旧的程序和UNIX这样的环境中，它的使用非常普遍。
例如：print_message_name（）；

四种命名规则的小结：
MyData就是一个帕斯卡命名的示例；myData是一个驼峰命名法,它第一个单词的第一个字母小写,后面的单词首字母大写,看起来像一个骆驼；iMyData是一个匈牙利命名法,它的小写的i说明了它的型态，后面的和帕斯卡命名相同，指示了该变量的用途。my_data则是下划线命名法。

---

命名的基本原则

(1) 标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。
尽量采用采用英文单词或全部中文全拼表示，若出现英文单词和中文混合定义时，使用连字符“_”将英文与中文割开。较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。例如：temp->tmp、flag->flg、statistic->stat、increment->inc、message->msg等缩写能够被大家基本认可。

(2) 命名中若使用特殊约定或缩写，则要有注释说明。
应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。

(3) 自己特有的命名风格，要自始至终保持一致，不可来回变化。
个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。

(4) 对于变量命名，禁止取单个字符(如i 、j 、k… )，建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i 、j 、k 作局部循环变量是允许的。
变量，尤其是局部变量，如果用单个字符表示，很容易敲错(如i写成j)，而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。

(5) 除非必要，不要用数字或较奇怪的字符来定义标识符。

(6) 命名规范必须与所使用的系统风格保持一致，并在同一项目中统一。

(7) 在同一软件产品内，应规划好接口部分标识符(变量、结构、函数及常量)的命名，防止编译、链接时产生冲突。
对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。

(8)用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
下面是一些在软件中常用的反义词组。
add / remove begin / end create / destroy
insert / delete first / last get / release
increment / decrement put / get
add / delete lock / unlock open / close
min / max old / new start / stop
next / previous source / target show / hide
send / receive source / destination
cut / paste up / down

(9)除了编译开关/ 头文件等特殊应用，应避免使用EXAMPLE_TEST 之类以下划线开始和结尾的定义。

---

变量名的命名规则

(1) 变量的命名规则要求用“匈牙利法则”。
即开头字母用变量的类型，其余部分用变量的英文意思、英文的缩写、中文全拼或中文全拼的缩写,要求单词的第一个字母应大写。
即： 变量名=变量类型+变量的英文意思(或英文缩写、中文全拼、中文全拼缩写)
对非通用的变量，在定义时加入注释说明，变量定义尽量可能放在函数的开始处。
见下表：
bool 用b开头 bFlg
int 用i开头 iCount
short int 用n开头 nStepCount
long int 用l开头 lSum
char 用c开头 cCount
unsigned char 用by开头
float 用f开头 fAvg
double 用d开头 dDeta
unsigned int(WORD) 用w开头 wCount
unsigned long int(DWORD) 用dw开头 dwBroad
字符串 用s开头 sFileName
用0结尾的字符串 用sz开头 szFileName

(2) 指针变量命名的基本原则
对一重指针变量的基本原则为：“p”+变量类型前缀+命名。如一个float * 型应该表示为pfState。
对二重指针变量的基本规则为：“pp”+变量类型前缀+命名。如一个float **型应该表示为ppfState。
对三重指针变量的基本规则为：“ppp”+变量类型前缀+命名。

(3) 全局变量用g_开头
如一个全局的长型变量定义为g_lFailCount。
即：变量名=g_+变量类型+变量的英文意思(或缩写)。此规则还可避免局部变量和全局变量同名而引起的问题。

(4) 静态变量用s_开头
如一个静态的指针变量定义为s_plPerv_Inst。即： 变量名=s_+变量类型+变量的英文意思(或缩写)

(5) 对枚举类型(enum)中的变量，要求用枚举变量或其缩写做前缀。并且要求用大写。
如：
enum cmEMDAYS
{
EMDAYS_MONDAY;
EMDAYS_TUESDAY;
……
};

(6) 对struct、union变量的命名要求定义的类型用大写。并要加上前缀，其内部变量的命名规则与变量命名规则一致。

结构一般用S开头，如：
struct ScmNPoint
{
int nX;//点的X位置
int nY; //点的Y位置
};

联合体一般用U开头，如:
union UcmLPoint
{
LONG lX;
LONG lY;
}

(7) 对常量(包括错误的编码)命名，要求常量名用大写，常量名用英文表达其意思。当需要由多个单词表示时，单词与单词之间必须采用连字符“_”连接。
如：#define CM_FILE_NOT_FOUND CMMAKEHR(0X20B) 其中CM表示类别。

(8) 对const 的变量要求在变量的命名规则前加入c_。
即：c_+变量命名规则；示例：const char* c_szFileName;

---

函数的命名规范

(1) 函数的命名应该尽量用英文(或英文缩写、中文全拼、中文全拼缩写)表达出函数完成的功能——函数名应准确描述函数的功能。
遵循动宾结构的命名法则，函数名中动词在前,并在命名前加入函数的前缀，函数名的长度不得少于8个字母。
函数名首字大写，若包含有两个单词的每个单词首字母大写。如果是OOP 方法，可以只有动词(名词是对象本身)。示例：
LONG GetDeviceCount(……);
void print_record( unsigned int rec_ind ) ;
int input_record( void ) ;
unsigned char get_current_color( void ) ;

(2) 避免使用无意义或含义不清的动词为函数命名。
如使用process、handle等为函数命名，因为这些动词并没有说明要具体做什么。

(3) 必须使用函数原型声明。
函数原型声明包括：引用外来函数及内部函数，外部引用必须在右侧注明函数来源： 模块名及文件名；内部函数，只要注释其定义文件名——和调用者在同一文件中(简单程序)时不需要注释。
应确保每个函数声明中的参数的名称、类型和定义中的名称、类型一致。

---

函数参数的命名规范

(1)参数名称的命名参照变量命名规范。

(2)为了提高程序的运行效率，减少参数占用的堆栈，传递大结构的参数，一律采用指针或引用方式传递。

(3)为了便于其他程序员识别某个指针参数是入口参数还是出口参数，同时便于编译器检查错误，应该在入口参数前加入const标志。
如：……cmCopyString(const char * c_szSource, char * szDest)

---

一些命名约定

命令规范基本上采用了微软推荐的匈牙利命名法，略有简化。
1． 常量
常量由大写字母和数字组成，中间可以下划线分隔，如 CPU_8051。
程序中少出现无意义的数字，常量尽量用宏替代。

2． 变量
变量由小写（变量类型）字母开头，中间以大写字母分隔，可以添加变量域前缀（变量活动域前缀以下划线分隔）。
如果变量名的含义十分明显，则不加前缀，避免烦琐。如用于循环的int型变量 i,j,k ；float 型的三维坐标（x,y,z）等。

3．函数名
函数命名采用动宾形式。如果函数为最底层，可以考虑用全部小写，单词间采用带下划线的形式。如底层图形函数：pixel、lineto以及读键盘函数get_key 等。

4． 符号名应该通用或者有具体含义，可读性强。尤其是全局变量，静态变量含义必须清晰。
C++中的一些关键词不能作为符号名使用，如class、new、friend等。符号名长度小于31个，与ANSI C 保持一致。命名只能用26个字母，10个数字，以及下划线‘’来组成，不要使用‘$’‘@’等符号。下划线‘’使用应该醒目，不能出现在符号的头尾，只能出现在符号中间，且不要连续出现两个。

---