C语言常见命名规范

1 常见命名规则

比较著名的命名规则首推匈牙利命名法，
这种命名方法是由Microsoft程序员查尔斯·西蒙尼(Charles Simonyi) 提出的。
其主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。
匈牙利命名法关键是：标识符的名字以一个或者多个小写字母开头作为前缀；
前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。
例如：lpszStr, 表示指向一个以'\0'结尾的字符串（sz）的长指针（lp）变量。

骆驼（Camel）命名法近年来越来越流行，
在许多新的函数库和Java这样的平台下使用得当相多。
骆驼命名法，正如它的名称所表示的那样，指的是混合使用大小写字母来构成标识符的名字。
其中第一个单词首字母小写，余下的单词首字母大写。
例如：printEmployeePaychecks()，函数名中每一个逻辑断点都有一个大写字母来标记。

帕斯卡（Pascal）命名法与骆驼命名法类似。
只不过骆驼命名法是第一个单词首字母小写，而帕斯卡命名法则是第一个单词首字母大写。
例如：DisplayInfo()和UserName都是采用了帕斯卡命名法。

在C#中，以帕斯卡命名法和骆驼命名法居多。
事实上，很多程序设计者在实际命名时会将骆驼命名法和帕斯卡结合使用，
例如变量名采用骆驼命名法，而函数采用帕斯卡命名法。

另一种流行的命名规则称为下划线命名法。
下划线法是随着C语言的出现流行起来的，在UNIX/LIUNX这样的环境，以及GNU代码中使用非常普遍。

本章所述的命名规则主要基于下划线命名法发展而来。

2 函数的命名

函数名使用下划线分割小写字母的方式命名：

设备名_操作名()

操作名一般采用：谓语（此时设备名作为宾语或者标明操作所属的模块）或者
谓语+宾语/表语（此时设备名作为主语或者标明操作所属的模块）等形式，如：

tic_init()
adc_is_busy()
uart_tx_char()

中断函数的命名直接使用设备名_isr() 的形式命名，如：
timer2_isr()

3 变量的命名

变量的命名也采用下划线分割小写字母的方式命名。
命名应当准确，不引起歧义，且长度适中。如：
int length;
uint32 test_offset;

单字符的名字也是常用的，如i, j, k等，它们通常可用作函数内的局部变量。

tmp常用做临时变量名。

局部静态变量，应加s_词冠（表示static），如：
static int s_lastw;

全局变量（尤其是供外部访问的全局变量），应加g_词冠（表示global），如：
void (* g_capture_hook)(void);

4 常量及宏的命名

采用下划线分割大写字母的方式命名，一般应以设备名作为前缀，
防止模块间命名的重复。如：

#define TIMER0_MODE_RELOAD 2
#define TIMER2_COUNT_RETRIEVE(val) ((uint16)(65536 - (val)))

当然，看作接口的宏可以按照函数的命名方法命名，例如：

#define timer2_clear() (TF2 = 0)
#define timer0_is_expired() (TF0)

5 常用缩写词

原词缩写

addition add
answer ans
array arr
average avg
buffer buf或buff
capture cap或capt
check chk
count cnt
column col
control ctrl
decode dec
define def
delete del
destination dst或dest
display disp
division div
encode enc
environment env
error err
float flt
frequency freq
header hdr
index idx
image img
increment inc
initalize init
iteration itr
length len
memory mem
middle mid
make mk
message msg
multiplication mul
number num
operand opnd
optimization opt
operator optr
packet pkt
positon pos
previous pre或prev
payload type pt
pointer ptr
return code rc
record rcd
receive recv
result res
return ret
source src
stack stk
string str
subtraction sub
table tab
temporary tmp或temp
total tot
time stamp ts
value val

6 结语

没有一种命名规则可以让所有的程序员赞同。而这多种命名规则也确实各有利弊。

没有必要花太多的精力试图发明最好的命名规则，
而是应当制定一种令大多数项目成员满意的命名规则并切实执行。
标识符命名的一致性自然会体现出代码的优雅。

当然，如果你的程序使用了第三方的代码，而这些模块经验证确实是正确无误的。
那么也没有必要一味追求命名的一致性，而去修改这些已经定型的模块中的函数和变量名。

(请您对文章做出评价)

«上一篇：功夫与编程
»下一篇：C++ Primer Chap17

##############################################################

C++代码规范之命名规则

作者：字体：[增加减小] 类型：转载时间：2013-07-12

以下是对C++中的命名规则进行了详细的分析介绍，需要的朋友可以参考下

一、命名的两个基本原则
1、含义清晰，不易混淆；
2、不和其它模块、系统API的命名空间相冲突。

二、命名通则
1、在所有命名中，都应使用标准的英文单词或缩写；不得使用拼音或拼音缩写，除非该名字描述的是文
特有的内容（如半角、全角、声母、韵母等）；除非必要，不要用数字或较奇怪的字符来定义标识符。
2、所有命名都应遵循达意原则，即名称应含义清晰、明确。
3、所有命名都不易过长，应控制在规定的最大长度以内。
4、所有命名都应尽量使用全称。
5、命名中若使用特殊约定或缩写，则要有注释说明。
6、自己特有的命名风格，要自始至终保持一致，不可来回变化。

说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定到的地方才可有个人命名风格）。

7、在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。
8、对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。

说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。
例：下面所示的局部变量名的定义方法可以借鉴。
int liv_Width
其变量名解释如下：
l 局部变量（Local）（其它：g全局变量（Global）...）
i 数据类型（Interger）
v 变量（Variable）（其它：c常量（Const）...）
Width 变量含义
这样可以防止局部变量与全局变量重名。

9、命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的　方式，用作特殊标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。
例： Add_User不允许，add_user、AddUser、m_AddUser允许。
10、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
说明：下面是一些在软件中常用的反义词组。

复制代码代码如下:

add / remove begin / end create / destroy   insert / delete
first / last get / releaseincrement / decrement   put / get
add / delete lock / unlockopen / closemin / max
old / newstart / stopnext / previoussource / target
show / hide send / receive   up / downcut / paste

例：

复制代码代码如下:

   int min_sum;
   int max_sum;
   int add_user( BYTE *user_name );
   int delete_user( BYTE *user_name );

11、除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。
12、程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。

三、具体规范
1、工程名
不强制统一。

2、文件名：
基于工程名，开头3个字母应表明与哪一个工程相关。
后面的字母应能够区别不同的功能。
不区分大小写。
长度不限于8.3格式，建议不多于30个字符。
若文件用于定义和实现类，建议文件名与类名保持一致。

3、函数名：
参照 Windows API 的命名规范。
推荐使用动宾结构。函数名应清晰反映函数的功能、用途。
函数名最长不得超过30个字符。
函数名第一个字母必须大写。
全局函数必须以小写前缀"g"开头。全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。
例：
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数

4、变量名：
原则上，变量名的命名遵从匈牙利记法。即：前缀 + 类型 + 变量名
变量名最长不得超过20个字符。
变量的名字应当使用“名词”或者“形容词＋名词”。
例：
float value;
float oldValue;
1）格式：[m_|s_|g_] type [class name|struct name] variable name
2）解释：
m_ ：类的成员变量
ms_：类的静态成员变量
s_ ：静态全局变量
g_ ：普通全局变量
类型缩写（type）
char, TCHAR： ch
char[]，TCHAR[]： sz
bool, BOOL： b
int, __int16,__int32,__int64： n
long： l
double： d
float： ft
BYTE： by
WORD： w
DWORD： dw
unsigned： u
function： fn
p ：pointer
lp ：pointer
5、类名：
必须以大写"K"开头，后面字母反映具体含义，以清晰表达类的用途和功能为原则。
接口必须以大写"I"开头，代表 Interface 。
当名称由多个单词构成时，每一个单词的第一个字母必须大写。

6、结构名、宏名、枚举名、联合名：
全部大写。
枚举名加小写前缀"enum"。
例：

复制代码代码如下:

typedef enum _KFILE_OPEN_MODE
{
enumOPEN_READONLY = 0;
enumOPEN_READWRITE = 1;
enumCREATE_ALWAY = 3 ;
} KFILE_OPEN_MODE;
宏名加小写前缀"def"。

例：
#define defMAXNUMBER 100
结构名加小写前缀"tag"，之后必须以大写"K"开头。
例：

复制代码代码如下:

typedef struct tagKPOINT
{
int x;
int y;
} KPOINT;

联合名加小写前缀"uni"。
例：

复制代码代码如下:

typedef union _VARIANT
{
char unichVal;
int uninVal;
long unilVal;
float uniftVal;
} VARIANT;

说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常量之前加上 “模块”标识等。
说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。
说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写。
一些单词有大家公认的缩写。
例：temp 可缩写为 tmp

复制代码代码如下:

   flag 可缩写为 flg
   statistic 可缩写为 stat
   increment 可缩写为 inc
   message 可缩写为 msg

http://www.cnblogs.com/liujiahi/archive/2011/09/16/2196348.html

http://c.biancheng.net/cpp/u/guifan/list_67_3.html

http://www.cnblogs.com/ggjucheng/archive/2011/12/15/2289291.html

http://www.jb51.net/article/39710.htm

http://wenku.baidu.com/link?url=nzoJj17fIfhlVTunzHpWOK3ZPi4AznivvXgSRVa94oRKATRuV4tIgiTqMlcBqK9fxZmkvtFNOFwBwlj3Dcws1xMytU7a9amGv1d1Xa--mJu