c语言库函数编程规范要点 c语言程序设计库函数( 二 )


m_Data member of a class一个类的数据成员
nShort int短整数
pPointer指针
sString字符串
szZero terminated String以0结尾的字符串
tmText metric文本规则
uUnsigned int无符号整数
ulUnsigned long (ULONG)无符号长整数
wWORD (unsigned short)无符号短整数
x,yx, y coordinates (short)坐标值/短整数
vvoid空
? 作用范围:
范围 前缀 例子
全局作用域 g_ g_Servers
成员变量 m_ m_pDoc
局部作用域 无 strName
? 数据类型
VC常用前缀列表
前缀 类型描述例子
chchar8位字符chGrade
chTCHAR16位UNICODE类型字符chName
bBOOL布尔变量bEnabled
nint整型(其大小由操作系统决定)nLength
nUINT无符号整型(其大小由操作系统决定) nLength
wWORD16位无符号整型wPos
lLONG32位有符号整型lOffset
dwDWORD32位无符号整型dwRange
p*内存模块指针,指针变量pDoc
lpFAR* 长指针lpDoc
lpszLPSTR32位字符串指针lpszName
lpszLPCSTR32位常量字符串指针lpszName
lpszLPCTSTR 32位UNICODE类型常量指针lpszName
hhandleWindows对象句柄hWnd
lpfn(*fn)()回调函数指针Callback Far pointer to
CALLBACK function lpfnAbort
2.2.2 函数、过程命名
函数或过程名的主体应该使用大小写混合形式 , 并且应该足够长以描述它的作用 。而且,函数名应该以一个动词起首 , 如 InitNameArray 或 CloseDialog 。对于频繁使用的或长的项,推荐使用标准缩略语以使名称的长度合理化 。一般来说,超过 32 个字符的变量名在 VGA 显示器上读起来就困难了 。当使用缩略语时,要确保它们在整个应用程序中的一致性 。在一个工程中,如果一会儿使用 Cnt,一会儿使用 Count,将导致不必要的混淆 。
对于自行编写的函数,若是系统关键函数,则须在函数实现部分的上方标明该函数的信息,格式如下:
//======================================================
// 函 数 名:InsureHasOutputInfo
// 功能描述:确保有适当的输出信息
// 输入参数:nProductID:相应的产品ID
// 输出参数:void
// 创建日期:00-2-21
// 修改日期:00-2-21
// 作者:***
// 附加说明:
//======================================================
2.2.3 用户定义类型
在一项有许多用户定义类型的大工程中,常常有必要给每种类型一个它自己的三个字符的前缀 。如果这些前缀是以 "u" 开始的,那么当用一个用户定义类型来工作时,快速识别这些类型是很容易的 。例如,ucli 可以被用来作为一个用户定义的客户类型变量的前缀 。
注:对于非通用的变量,请在定义时加以注释说明 , 变量定义尽可能放在最开始处 。
2.2.4 控件命名
应该用一致的前缀来命名对象,使人们容易识别对象的类型 。
VC常用宏定义命名列表
前缀符号类型符号例子范围
IDR_标识多个资源共享的类型 IDR_MAINFRAME1~0x6FFF
IDD_对话框资源(Dialog)IDD_SPELL_CHECK1~ 0x6FFF
HIDD_基于对话框的上下文帮助 HIDD_SPELL_CHECK0x20001~0x26FF
IDB_位图资源(Bitmap)IDB_COMPANY_LOGO 1~0x6FFF
IDC_光标资源(Cursor)IDC_PENCIL1~0x6FFF
IDI_图标资源(Icon)IDI_NOTEPAD1~0x6FFF
ID_、IDM_ 工具栏或菜单栏的命令项 ID_TOOLS_SPELLING0x8000~0xDFFF
HID_命令上下文帮助HID_TOOLS_SPELLING 0x18000~0x1DFFF
IDP_消息框提示文字资源IDP_INVALID_PARTNO 8~0xDFFF
HIDP_消息框上下文帮助HIDP_INVALID_PARTNO 0x30008~0x3DFFF
IDS_字符串资源(String)IDS_COPYRIGHT1~0x7FFF
IDC_对话框内的控制资源IDC_RECALC8~0xDFFF
2.3源代码规则

推荐阅读