团队合作时对于函数名、类名……的命名规范

C/C++源代码书写规范（试行）

在.h/.cpp的开头应有一段格式统一的说明，内容包括：

文件名 (FileName)；
简短说明文件功能、用途 (Comment)；
创建人 (Creater)；
文件创建时间 (Date)。

 
xxxxxxxxxx
例：
/**********/
/**@file***/
/**@brief**/
/**@author*/
/**@date***/
/**********/

除非极其简单，否则对函数应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或补充说明。

每行代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。

 
xxxxxxxxxx
例：
    HANDLE CSOpenFile(const char cszFileName[],
                    int nMode);
    或者：
    BOOL CSReadFile(
                    HANDLE hFile,
                    void *pvBuffer,
                    int nReadSize,
                    int *pnReadSize
                    );

循环、分支代码，判断条件与执行代码不得在同一行上。

 
xxxxxxxxxx
例：正确：
    if (n == -2)
        n = 1;
    else
        n = 2;
    不得写做：
    if (n == -2) n = 1;
    else n = 2;

指针的定义，* 号既可以紧接类型，也可以在变量名之前。

 
xxxxxxxxxx
例：
    可写做：int* pnsize;
    也可写做：int *pnsize;
    但不得写做：int * pnsize;

在类的成员函数内调用非成员函数时，在非成员函数名前必须加上“::”。

函数入口参数有缺省值时，应注释说明。

 
xxxxxxxxxx
例:
BOOL KSSaveToFile(const char cszFileName[],BOOL bCanReplace /* = TRUE */);

else if 必须写在一行。

与‘{’、‘}’有关的各项规定：

‘{’‘}’应独占一行，在该行内可有注释（如果没有独占一行，那么它的下一行必须是个空行（空行上可以放注释），‘{’前必须有一个空格

 
xxxxxxxxxx
例：正确：
    for (i = 0; i < cbLine; i++)
    { // .....
        printf("Line %d:", i);
        printf("%s\n", pFileLines);
    }
    for (i = 0; i < cbLine; i++) {
        // .....
        printf("Line %d:", i);
        printf("%s\n", pFileLines);
    }
    不得写做：
    for (i = 0; i < cb; i++)
    {printf("Line %d:", i);
    printf("%s\n", pFileLines);}

‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。

 
xxxxxxxxxx
例：正确：
    if (i > 0) {
        m = 1;
        n++;
    }
    不得写做：
    if (i > 0) {
    m = 1;
    n++;
    }
    例外：
    if (i == 0)
    { ASSERT(FALSE); return; }

在循环、分支之后若只有一行代码，虽然可省略‘{’、‘}’，但不推荐这么做。若省略后可能引起歧义，则必须加上‘{’、‘}’。

与空格有关的各项规定。

在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘.’、‘[’、‘]’等运算符前后，及‘&’（取地址）、‘*’（取值）等运算符之后不得有空格。

 
xxxxxxxxxx
例：正确：
    int n = 0, nTemp;
    for (int i = nMinLine; i <= nMaxLine; i++)
    不得写做：
    int n=0, nTemp;
    for ( int i=nMinLine; i<=nMaxLine; i++ )

for、while、if 等关键词之后应有1个空格，再接‘(’，之后无空格；在结尾的‘)’前不得有空格。

 
xxxxxxxxxx
例：正确：
    if (-2 == n)
    不得写做：
    if(-2 == n)
    或
    if ( -2 == n )

调用函数、宏时，‘(’、‘)’前后不得有空格。

 
xxxxxxxxxx
例：正确：
    printf("%d\n", nIndex);
    不得写做：
    printf ("%d\n", nIndex);
    printf( "%d\n", nIndex );

类型强制转换时，‘(’‘)’前后不得有空格

 
xxxxxxxxxx
例：可写做：
    (KSFile*)pFile;
    也可写做：
    (KSFile *)pFile
    不得写做：
    ( KSFile* )pFile
    ( KSFile * ) pFile

与缩进有关的各项规定

缩进以 Tab 为单位。1 个 Tab 为 4 个空格
下列情况，代码缩进一个 Tab:
1. 函数体相对函数名及‘{’、‘}’。
  - ```
   
  xxxxxxxxxx
  例：
      int Power(int x)
      {
      　　return (x * x);
      }
```
2. if、else、for、while、do 等之后的代码。
3. 一行之内写不下，折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运算符，则运算符应在上一行末尾，而不应在下一行的行首。

下列情况，不必缩进：switch 之后的 case、default。

 
xxxxxxxxxx
例：
    switch (nID)
    {
    case ID_PLAY:
    　　......
    　　break;
    case ID_STOP:
    　　......
    　　break;
    default:
    　　......
    　　break;
    }

命名规范的整体原则：

同一性
在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在整个模块中的同一性。
标识符组成
标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。
所有命名都应尽量使用全称。
最小化长度 && 最大化信息量原则
在保持一个标识符意思明确的同时，应当尽量缩短其长度。
避免过于相似
不要出现仅靠大小写区分的相似的标识符，例如“i”与“I”，“function”与“Function”等等。
避免在不同级别的作用域中重名
程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但容易使人误解。
正确命名具有互斥意义的标识符
用正确的反义词组命名具有互斥意义的标识符，如："nMinValue"和"nMaxValue"，"GetName()" 和 "SetName()" ....
避免名字中出现数字编号
尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。
不得使用拼音
在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。
缩写原则
如果命名使用缩写，则应该使用《通用缩写表》中的缩写
原则上不推荐使用《通用缩写表》以外的缩写，如果使用，则必须对其进行注释和说明。

常见命名法：

匈牙利命名法：
基本原则是：
- 变量名＝属性＋类型＋对象描述
- 其中每一对象的名称都要求有明确含义
- 可以取对象名字全称或名字的一部分
- 命名要基于容易记忆容易理解的原则
- 保证名字的连贯性是非常重要的
Camel命名法（即骆驼式命名法）：
基本原则是：
- 原因是采用该命名法的名称看起来就像骆驼的驼峰一样高低起伏
- Camel命名法有两种形式
- 混合使用大小写字母和单词之间加下划线
- 例如runFast和run_fast都属于Camel命名法
Pascal命名法：
基本原则是：
- 与Camel命名法类似，不过Pascal命名法的首字母为大写字母。

工程名：

不强制统一。

文件名：

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

类/结构

除了异常类等个别情况（不希望用户把该类看作一个普通的、正常的类之情况）外，C++类/结构的命名应该遵循以下准则：
C++类/结构的命名
- 类的名称都要以大写字母“C”开头，后跟一个或多个单词。为便于界定，每个单词的首字母要大写。
推荐的组成形式 *类的命名推荐用"名词"或"形容词＋名词"的形式，例如："CAnalyzer", "CFastVector" ....
不同于C++类的概念，传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为：
传统C结构体的命名
- 传统C结构体的名称全部由大写字母组成，单词间使用下划线界定，例如："SERVICE_STATUS", "DRIVER_INFO" ....

函数

函数的命名
参照 Windows API 的命名规范。
函数的名称由一个或多个单词组成。为便于界定，每个单词的首字母必须要大写
函数名最长不得超过30个字符
全局函数必须以小写前缀"g"开头
推荐的组成形式
函数名应当使用"动词"或者"动词＋名词"（动宾词组）的形式。例如："GetName()", "SetValue()", "Erase()", "Reserve()" ....
保护成员函数
保护成员函数的开头应当加上一个下划线“”以示区别，例如："SetState()" ....
私有成员函数
类似地，私有成员函数的开头应当加上两个下划线“”，例如："DestroyImp()" ....
虚函数
虚函数习惯以“Do”开头，如："DoRefresh()", "_DoEncryption()" ....
回调和事件处理函数
回调和事件处理函数习惯以单词“On”开头。例如："_OnTimer()", "OnExit()" ....

变量

变量应该是程序中使用最多的标识符了，变量的命名规范可能是一套C++命名准则中最重要的部分：
变量的命名
- 变量名由作用域前缀＋类型前缀＋一个或多个单词组成。为便于界定，每个单词的首字母要大写。
- 对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i, j, k, x, y, z ....
格式
- [m|s|g_……] type [class name|struct name] variable name
作用域前缀
- 作用域前缀标明一个变量的可见范围。作用域可以有如下几种：
- 除非不得已，否则应该尽可能少使用全局变量。
类型前缀
- 类型前缀标明一个变量的类型，可以有如下几种：
- 类型前缀可以组合使用，例如"gc"表示字符数组，"ppn"表示指向整型的指针的指针等等。
推荐的组成形式
- 变量的名字应当使用"名词"或者"形容词＋名词"。例如："nCode", "m_nState"，"nMaxWidth" ....

作用域前缀说明

前缀	说明
无	局部变量
m_	类的成员变量（member）
sm_	类的静态成员变量（static member）
s_	静态变量（static）
g_	外部全局变量（global）
sg_	静态全局变量（static global）
gg_	进程间共享的共享数据段全局变量（global global）

类型前缀说明

前缀	说明
n	整型和位域变量（number）
e	枚举型变量（enumeration）
c	字符型变量（char）
b	布尔型变量（bool）
f	浮点型变量（float）
u	无符号（unsigned）
p	指针型变量和迭代子（pointer）
lp	长指针型变量和迭代子（long pointer）
pfn	特别针对指向函数的指针变量和函数对象指针（pointer of function）
g	数组（grid）
str	字符串（string）
i	类的实例（instance）对于经常用到的类，也可以定义一些专门的前缀，如：std::string和std::wstring类的前缀可以定义为"st" std::vector类的前缀可以定义为"v"等等。

常量

C++中引入了对常量的支持，常量的命名规则如下：
常量的命名
- 常量名由类型前缀＋全大写字母组成，单词间通过下划线来界定，如：cDELIMITER, nMAX_BUFFER ....
- 类型前缀的定义与变量命名规则中的相同。

枚举、联合、typedef

枚举、联合及typedef语句都是定义新类型的简单手段，它们的命名规则为：
枚举、联合、typedef的命名
- 枚举、联合、typedef语句生成的类型名由全大写字母组成，单词间通过下划线来界定，如：FAR_PROC, ERROR_TYPE ....

宏、枚举值

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

通用缩写表

说明：

本缩写表是“编码命名规范”的附录。
本缩写表中列出的都是通用性缩写，不提供标准缩写，如：Win9x，COM等。
使用本缩写表里的缩写时，请对其进行必要的注释说明。
除少数情况以外，大部分缩写与大小写无关。

通用缩写表

缩写	全称
addr	Address
adm	Administrator
app	Application
arg	Argument
asm	assemble
asyn	asnychronization
avg	average
DB	Database
bk	back
bmp	bitmap
btn	Button
buf	Buffer
calc	Calculate
char	Character
chg	Change
clk	Click
clr	color
cmd	Command
cmp	Compare
col	Column
coord	coordinates
cpy	copy
ctl/ctrl	Control
cur	Current
cyl	Cylinder
dbg	Debug
dbl	Double
dec	Decrease
def	default
del	Delete
dest/dst	Destination
dev	Device
dict	dictionary
diff	different
dir	directory
disp	Dosplay
div	Divide
dlg	Dialog
doc	Document
drv	Driver
dyna	Dynamic
env	Environment
err	error
ex/ext	Extend
exec	execute
flg	flag
frm	Frame
func/fn	Function
grp	group
horz	Horzontal
idx/ndx	Index
img	Image
impl	Implement
inc	Increase
info	Information
init	Initial / Initialize / Initializatioin
ins	Insert
inst	Instance
INT / intr	Interrupt
len	Length
lib	Library
lnk	Link
log	logical
lst	List
max	maximum
mem	Memory
mgr / man	Manege / Manager
mid	middle
min	minimum
msg	Message
mul	Multiply
num	Number
obj	Object
ofs	Offset
org	Origin / Original
param	Parameter
pic	picture
pkg	package
pnt / pt	Point
pos	Position
pre / prev	previous
prg	program
proc	Process / Procedure
prop	Properties
psw	Password
ptr	Pointer
pub	Public
rc	rect
ref	Reference
reg	Register
req	request
res	Resource
ret	return
rgn	region
scr	screen
sec	Second
seg	Segment
sel	Select
src	Source
std	Standard
stg	Storage
stm	Stream
str	String
sun	Subtract
sum	summation
svr	Server
sync	Synchronization
sys	System
tbl	Table
temp / tmp	Temporary
tran / trans	translate / transation / transparent
tst	Test
txt	text
unk	Unknown
upd	Update
upg	Upgrade
util	Utility
var	Variable
ver	Version
vert	Vertical
vir	Virus
wnd	Window

未完结

参考：
ggjucheng 静默虚空 zxysilently.

团队合作时对于函数名、类名……的命名规范

C/C++源代码书写规范（试行）

命名规范的整体原则：

常见命名法：

工程名：

文件名：

类/结构

函数

变量

作用域前缀说明

类型前缀说明

常量

枚举、联合、typedef

宏、枚举值

通用缩写表

说明：

通用缩写表

未完结

参考：