关于编成规范-命名规则的浅谈

 2009-11-17

关于编成规范-命名规则的浅谈本命名取自“匈牙利”法，仅供参考。数据类型的命名规则参考：定义类型：前缀类型类型描述示例所占字节(Win32)有效值取值范围bBoolena-布尔1Bit的标志bool bFlag4(TRUE/FALSE)(0x0 ~0x1)/* typedef int bool */----------------------------------------------------------------------------------------byByte 字节无符号的8bit字节unsigned char byValue;10 ~255(0x0 ~0xFF)chChar 字符有符号的8bit字节signed char chValue;1-128~127(0x80~0x7F)----------------------------------------------------------------------------------------w不带符号的Word字无符号的16bit整数unsigned short wValue;20 ~65535(0x0 ~0xFFFF)sw带符号的16位整形数有符号的16bit整数signed short swValue;2-32768~32767(0x8000~0x7FFF)----------------------------------------------------------------------------------------dw不带符号的doubleword字无符号的32bit整数unsigned int dwValue;40 ~4294967295(0x0 ~0xFFFFFFFF)n带符号的32位整形数有符号的32bit整数signed int nValue;4-2147483648~2147483647(0x80000000~0x7FFFFFFF)----------------------------------------------------------------------------------------f单精度浮点数单精度浮点数float fValue;4d双精度浮点数双精度浮点数double dValue;8----------------------------------------------------------------------------------------p指针(pointer)指针char *pchName;4pcconst指针(pointer)const指针const char *pcchName;//* unsigned char *pbyData; / unsigned short *pwData; *//* const int *pcnData; / unsigned int *pdwData; */----------------------------------------------------------------------------------------ttypedef自定义类型struct结构体等类型TNameInfo tName;/pt自定义类型指针struct结构体指针等PTNameInfo *ptName;/----------------------------------------------------------------------------------------aArray数组数组char achName[20];/aa二位Array数组多位数组unsigned char aabyName[4][2];/----------------------------------------------------------------------------------------ap存放指针的数组存放指针的数组char *apchName[2];/pa指向数组的指针指向数组的指针unsigned char *pabyName;/----------------------------------------------------------------------------------------emenum枚举类型枚举类型EM_NAME emName;4cclass类class类CName cName;/----------------------------------------------------------------------------------------pf函数指针(pointer func)函数指针typedef int (*pfMsgFunc)(int type);----------------------------------------------------------------------------------------s_静态变量(static)静态变量static int s_nValue;g_全局变量(global)全局变量int g_nValue;m_类的数据成员(member)类的数据成员int m_nValue;函数名的命名规则参考：1. 函数名的首字母建议大写，函数名采用大小写字母结合的形式int GetMaxValue(void){do someting;}2. 定义函数时，若函数无返回值，请冠以void 函数名格式；若函数无参数，请在参数中写入void格式；void InitData(void){do someting;}1. 全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。DrawBox(void); // 全局函数2. 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。void SetValue(int nValue){g_nValue = nValue;}int GetValue(void){return g_nValue;}3. 回调函数最好出现“CB”字符；typedef int (*pfTimerCB)(int type);CreateTimer(g_TaskTimer, TaskTimerCB, NULL);3. 在同一软件产品内，避免重名的函数出现我们在不同的文件中都可以通过定义同样的函数模块Astatic void InitData(void); // 最好改成 static void InitAData(void);模块Bstatic void InitData(void); // 最好改成 static void InitBData(void);4. 函数名的长度最好小于30字符内。可以使用缩略词语，但是要有必要的全词注释。tSysPara *GetSysPara(void) // tSystemPara *GetSystemParameter(void)5. 一个函数代码最好控制在100行以内，一个模块文件，代码最好控制在1000行以内。6. 最后，还有一点小小的建议，就是无论我们使用那种工具编写代码，VC6.0,SourceInsignt,UltraEdit,等请按照格式排板，对齐，并将tab转换成4个空格，这样便于察看，修改等。代码示例：与零值比较(摘自林锐博士-高质量C++/C 编程指南)1. 布尔变量与零值比较不可将布尔变量直接与TRUE、FALSE 或者1、0 进行比较。根据布尔类型的语义，零值为“假”（记为FALSE），任何非零值都是“真”（记为TRUE）。TRUE 的值究竟是什么并没有统一的标准。例如Visual C++ 将TRUE 定义为1，而Visual Basic 则将TRUE 定义为-1。假设布尔变量名字为flag，它与零值比较的标准if 语句如下：if (flag) // 表示flag 为真if (!flag) // 表示flag 为假其它的用法都属于不良风格，例如：if (TRUE == flag)if (1 == flag)if (FALSE == flag)if (0 == flag)2. 整型变量与零值比较应当将整型变量用“==”或“！=”直接与0 比较。假设整型变量的名字为value，它与零值比较的标准if 语句如下：if (0 == value)if (0 != value)不可模仿布尔变量的风格而写成if (value) // 会让人误解 value 是布尔变量if (!value)3. 浮点变量与零值比较不可将浮点变量用“==”或“！=”与任何数字比较。千万要留意，无论是float 还是double 类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“！=”与数字比较，应该设法转化成“>=”或“<=”形式。假设浮点变量的名字为x，应当将if (0.0 == x) // 隐含错误的比较转化为if ((x>=-EPSINON) && (x<=EPSINON))其中EPSINON 是允许的误差（即精度）。C++const float EPSINON = 0.00001;C#define EPSINON (float)0.000014. 指针变量与零值比较应当将指针变量用“==”或“！=”与NULL 比较。指针变量的零值是“空”（记为NULL）。尽管NULL 的值与0 相同，但是两者意义不同。假设指针变量的名字为p，它与零值比较的标准if 语句如下：if (NULL == p) // p 与NULL 显式比较，强调p 是指针变量if (NULL != p)不要写成if (0 == p) // 容易让人误解p 是整型变量if (0 != p)或者if (p) // 容易让人误解p 是布尔变量if (!p)