研发代码规范.doc

文档介绍：一、命名规则
变量:
局部变量:
格式:变量类型(小写字母简拼) + 描述变量功能的单词或拼音(首字母大写)。
例如: LONG t = 0 ; // 当前活动设备IP数量
PBYTE pReadBuffer = NULL ; // 读数据缓冲区
HANDLE hIniFile = INVALID_HANDLE_VALUE ; // 配置文件
全局变量:
格式: g_ + 局部变量名字
例如: LONG t = 0 ;
PBYTE g_pReadBuffer = NULL ;
HANDLE g_hIniFile = INVALID_HANDLE_VALUE ;
类成员变量:
格式::m_ + 局部变量名字
例如:LONG t ;
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 <> 格式来引用标准库的头文件