研发代码规范.docVIP

一、命名规则 变量： 局部变量: 格式：变量类型(小写字母简拼) + 描述变量功能的单词或拼音(首字母大写)。 例如： LONG lActiveIpCnt = 0 ; // 当前活动设备IP数量 PBYTE pReadBuffer = NULL ; // 读数据缓冲区 HANDLE hIniFile = INVALID_HANDLE_VALUE ; // 配置文件 全局变量: 格式： g_ + 局部变量名字 例如： LONG g_lActiveIpCnt = 0 ; PBYTE g_pReadBuffer = NULL ; HANDLE g_hIniFile = INVALID_HANDLE_VALUE ; 类成员变量: 格式:：m_ + 局部变量名字 例如：LONG m_lActiveIpCnt ; PBYTE m_pReadBuffer ; HANDLE m_hIniFile ; 字符串 多个字符串名称以sz开头 例如：char szBuf[256]; 结构成员变量: 格式： 同 局部变量 例如： typedef struct _EDP_DEVICE_ADDR_INFO { ULONG uIpAddr ; BYTE byMacAddr [EDP_MAC_LEN] ; } EDP_DEVICE_ADDR_INFO, * LPEDP_DEVICE_ADDR_INFO ; #define EDP_DEVICE_ADDR_INFO_LEN sizeof (EDP_DEVICE_ADDR_INFO) 变量 初始化 定义变量的同时完成初始化 函数： 格式：描述函数功能的单词组合，单词首字母大写，其余小写。 例如：BOOL GetUserName (LPTSTR lpBuffer, LPDWORD pdwSize ) ; 类： 格式：C (Class的标志，大写字母) + 类的描述性名称 例如： class CScanManager { public: CScanManager () ; ~ CScanManager () ; } ; 结构： 格式：typedef struct + _ (下划线) + 结构描述性名称（大写字母，单词间用下划线分割） 例如： typedef struct _EDP_DEVICE_ADDR_INFO { ULONG uIpAddr ; BYTE byMacAddr [EDP_MAC_LEN] ; } EDP_DEVICE_ADDR_INFO, * LPEDP_DEVICE_ADDR_INFO ; #define EDP_DEVICE_ADDR_INFO_LEN sizeof (EDP_DEVICE_ADDR_INFO) EDP_DEVICE_ADDR_INFO daiDeviceAddrInfo = {0} ; LPEDP_DEVICE_ADDR_INFO pDevAddrInfo = NULL ; 二、排版 1、新建文件要在文件开始出写明如下结构： /*++ 作者： 时间： 功能： 文件名称： --*/ 2、文件开始出用应当用ifndef/define/endif 结构产生预处理块。 3、用 #include filename.h 格式来引用标准库的头文件，用 #include “filename.h” 格式来引用非标准库的头文件。 4、在每个类声明之后、每个函数定义结束之后都要加空行，在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 5、变量尽量声明在文件开始处或者函数开始处，??且做到一块声明中变量对齐。 6、一行代码只做一件事情(定义一个变量)，判断，循环语句各占一行，执行其他语句不仅跟其后，而判断，循环语句的执行语句有多少都要加{}。 7、代码行最大长度宜控制在70至80个字符以内。代码不要过长否则眼睛看不过来。长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可选。 8、if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。 9、程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。 10、应当将修饰符 * 和＆ 紧靠变量名。 11、尽可能在定义变量的同时初始化该变量。 12、指针声明的时候赋值为NULL，释放内存后要将指针赋值为NULL。在使用指针的时候尽量判断指针是否为