驼峰式与下划线命名规则

在实际代码开发过程中，代码编写格式清晰与否不仅决定了自己的代码编写与维护成本，也直接影响到项目的开发进度。编码中常用的有驼峰法和下划线两种编码格式，其中驼峰法常用在面向对象的高层语言中，下划线方法常用在偏向底层的语言中。

1. 驼峰命名规则(Camel case With hungarian notation)

驼峰式命名法（camel-case）一次来自于Perl语言中普遍使用的大小写混合格式，而Larry wall等人所著的畅销书《program Perl》（o'Relly出版）的封面图片正是一匹骆驼，故而得名。驼峰法在C++等高级语言中被广泛使用，下划线方法占据现有的C语言体系。匈牙利方法在win的老用户中广泛被使用，但是匈牙利方法在当下命名体系当中使用越来越少。或者，准确的讲是随着技术进步，这种命名逐渐与驼峰法结合再了一起形成了一种适合于现在C++等高级语言的项目命名规范。  

驼峰式命名法分为大驼峰(big camel-case)和小驼峰(little camel-case)两种。其中，大驼峰特点是首字母与后边字母都是大写，常用于类名、函数名、属性和命名空间。相比较，小驼峰特点是首单词开头字母小写后边字母都是大写，常用于局部变量。

## 概要 General  

如果想要管理一个稍微复杂一点的体系，针对其中的食物一套统一、带层次结构、清晰明了的命名准则就是必不可少而且非常好用的工具。  

活跃在生物学、化学、军队、监狱、黑社会、恐怖组织等各个领域内的大量有识先辈都曾经无数次的以实际行动证明了以上公理的正确性。除了上帝（设他可以改变世间万物的秩序）以外，象形没有人有实力对它不屑一顾。在软件开发这一高度抽象而且高度复杂的活动中，命名规则的重要性更显得尤为突出。一套定义良好并且完整的、再整个项目中统一使用的命名规范将大大提升源代码的可读性和软件的可维护性。在引入细节之前，先说明一下命名规范的整体原则：  

标准	说明
统一性	在编写一个子模块活派生类的时候，要遵循其基类或整体模块的命名规范风格，保持命名规范风格再整个模块中的统一性
标识组成	标识符采用英文单词或其组合，应当只管且可以平度，有望文知意，用词适当准确
最小化长度与最大化信息量原则	再保持一个标识符意思明确的同时，尽量缩短其长度。方法是准确使用英语，同时使用单词缩写
避免过于相似	不要出现仅靠大小写区分的相似标识符，例如“i”与“I”，“function” 与“Function”等等。
避免在不同级别的作用域中重名	程序不要出现名字完全相同的局部变量和全局变量，尽管两者作用于不同而不会发生语法错误，但容易使人误解
正确命名具有互斥意义的标识符	用正确的反义词命名具有互斥意义的标识符，如：“nMinValue”和“nMaxValue”，“GetName()”和“SetName()”
避免名字中出现数字编号	尽量名字中出现数字编号，如value1，value2等，除非逻辑上的确需要编号。这是为了放置程序员偷懒，不肯为命名董道静而导致产生无意义的名字（因为数字编号最省事）。

## 类/结构class  

除了异常类等个别情况（不希望用户把该类看做一个普通的正常的类之情况）外，C++类/结构的命名应该遵循以下准则：

类型	命名方法
C++类/结构的命名	类的名称都是以大写字母“C"开头，后跟一个活多个单词。为便于界定，每个单词的首字母要大写
推荐的组成形式	类的命名推荐用名词或形容词+名词的形式，例如：“CAnalyzer”，“CFastVector”等等
传统C结构体命名	传统C结构体的名称全部有大写字母组成，单词间使用下划线界定，例如：SERVICE_STATUS

不同于C++类的概念，传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则：

## 函数 Function  

类型	说明
函数命名	函数的名称由一个或多个单词组成，为便于界定，每个单词的首字母要大写
推荐的组成形式	函数名应当使用动词或者动词+名词（动宾词组）的形式。例如：“GetName()", "SetValue()","Reserve()"
保护成员函数	保护成员函数的开头应该加上一个下划线“-”以示区别，例如：“————SetState()”
私有成员函数	类似地，私有成员函数的开头应当加上两个下划线“__”，例如：“__DestoryImp()”
虚函数	虚函数习惯使用Do开头，例如：“DoRefresh()","_DoEncryption()”
回调和事件处理函数	回调和时间处理函数习惯以单词“On”开头，例如：“_OnTimer()"

## 变量  

变量应该是程序中使用最多的标识符，变量的命名规范可能是一套C++标准规范中最重要的部分，具体命名规范如下：

变量的命名  变量有作用域前缀+类型前缀+一个或多个单词组成。为了便于界定，每个单词的首字母要大写。对于某些用途简单的明了的局部变量，也可以使用简化的方式，例如：i,j,k....

作用域前缀          作用域前缀主要是标明一个变量的可见范围。作用域可以有如下几种：

前缀                说明

无                  局部变量

m_                  类的成员变量（member）

sm_                 类的静态成员变量（static member）

s_                  静态变量（static）

g_                  外部全局变量（global）

sg_                 静态全局变量（static glboal）

gg_                 进程共享的共享数据段全局变量（global global）

除非不得已，否则应该竟可能少的使用全局变量  

类型前缀            类型前缀标明一个变量的类型

前缀                说明

n                   整形和位域变量（number）

e                   枚举型变量（enumeration）

c                   字符型变量（char）

b                   布尔型变量（bool）

f                   浮点型变量（float）

p                   指针型变量和迭代子（pointer）

pfn                 特别针对直线函数的指针变量和函数对象指针（pointer of function)

g                   数组（grid）

i                   类的实例（instance）

                    对于经常使用到的类也可以定义一些专门的前缀，比方说std::vector这种容器类型的固有约束型变量，可以使用v等

                    类型前缀可以组合使用，例如“gc”表示字符数组，“ppn”表示只想整形的指针的指针等

char*/wchar_t* -> psz

char[]/wchar_t[] ->sz

sz 表示string end of zero

S                   结构体 SAddress

前缀

类型

描述

实例

c

char

8位字符

cGrade

str string  字符型 strName

ch

TCHAR

如果_UNICODE定义，则为16位字符

chName

b

BOOL

布尔值

bEnable

n ,i

int

整型（其大小依赖于操作系统）

nLength

si

short int   短整型 siSequ

n

UINT

无符号值（其大小依赖于操作系统）

nHeight

w

WORD

16位无符号值

wPos

f

float   浮点型 fRadius

d

double  双精度型    dArea

l

LONG

长整型

lOffset

ld

long double 长双精度型   ldRate

dw

DWORD

32位无符号整型

dwRange

p

*

指针

pDoc

lp

FAR*

远指针

lpszName

lpsz

LPSTR

32位字符串指针

lpszName

lpsz

LPCSTR

32位常量字符串指针

lpszName

lpsz

LPCTSTR

如果_UNICODE定义，则为32位常量字符串指针

lpszName

h

handle

Windows对象句柄

hWnd

lpfn

callback

指向CALLBACK函数的远指针

?

if

输入文件流   ifDataFile

of

输出文件流   ofStuFile

sz

以"\0"结束的字符串 szAppName

 

推荐的组成形式       变量的名字应当使用名词或者形容词+名词。例如：“nCode”，“m_nState”，“nMaxWidth”

## 常量

常量的命名有类型前缀+全大写字母组成，单词间通过下划线来界定，如：cMAX_BUFFER。类型前缀的定义与变量命名规则相同。

## 枚举、联合、typedef

枚举、联合以及typedef语句生成的累死你个名有全大写字母组成，单词间通过下划线来界定，如：FAR_PROC

## 宏、枚举值  

宏和枚举值由全大写字母组成，单词通过下划线来界定，如：ERROR_UNKNOWN，OP_STOP...

## Property  

g_                  Global variable/function  

c_                  Const variable

C                   class  

m_                  Member of struct/class  

s_                  Static variable  

S                   Struct  

## Componnet

Button              btn

Label               lbl

TextBox             txt

## varibal  

pointer             p  

char*

2. 下划线命名规则

在Linux操作系统这种用C语言写的代码中，根据之前的编码风格延续使用下划线编码规范。这种编码规范相比于驼峰法差别在于文字之间组成意义单词语义分割方式，下划线使用“_”进行区分。在其他变量方便的定义和区分规则，两者之间是没有差别的。