豪侠专用客户端命名.pdfVIP

前言

规定了工程名、文件名、函数名、变量名、类/结构名、宏、常量、枚举、联合

等名规范。

制定的目的是统一方舟程序命名规范，以便于代码的阅读、、管理及

修订。

需要对进行修订增删时，须由研发部经理组织相关人员集体讨论，先达成共识，

再进行修改。

命名规范（试行）

通则：

1、在所有命名中，都应使用标准的英文单词或缩写。使用或缩写，除非该名字

描述的是中文特有的内容，如半角、全角,声母、韵母等。

2、所有命名都应遵循达意原则，即名称应含义清晰、明确。

3、所有命名都不易过长，应控制在规定的最大长度以内。

4、所有命名都应尽量使用全称。

5、如果命名使用缩写，则应该使用《通用缩写表》（见附录）中的缩写；原则上不推荐使用

《通用缩写表》以外的缩写，如果使用，则必须对其进行注释和说明。

具体规范：

1、工程名：

不强制统一。

2、文件名：

·基于工程名，开头3个字母应表明与哪一个工程相关。

·后面的字母应能够区别不同的功能。

·不区分大小写。

·长度不限于8.3格式，建议不多于30个字符。

·若文件用于定义类，建议文件名与类名保持一致。

3、函数名：

·参照WindowsAPI名规范。

·推荐使用动宾结构。函数名应清晰反映函数的功能、用途。

·函数名最长超过30个字符。

·函数名第一个字母必须大写。

·全局函数必须以小写前缀g开头。

4、变量名：

原则上，变量名名遵从匈牙利记法。即：前缀+类型+变量名

1）格式：

[m_|s_|g_]type[classname|structname]variablename

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：f

·BYTE：by

·WORD：w

·DWORD：dw

·unsigned：u

·function：fn

·p：pointer

·lp：pointer

变量名最长超过20个字符。

5、类名：

·必须以大写C开头，后面字母反映具体含义，以清晰表达类的用途和功能为原则。

·接口必须以大写I开头，代表Interface。

·当名称由多个单词构成时，每一个单词的第一个字母必须大写。

6、结构名、宏名、枚举名、联合名：

·全部大写

。

·枚举名加小写前缀enum。

例：

typedefenum_FILE_OPEN_MODE

{

enumOPEN_READONLY=0,

enumOPEN_READWR