匈牙利命名法
来源:互联网 发布:怎样编程 编辑:程序博客网 时间:2024/05/05 09:25
命名规范和C/C++源代码书写
通则:
1、在所有命名中,都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写,除非该名字描述的是中文特有的内容,如半角、全角, 声母、韵母等。
2、所有命名都应遵循达意原则,即名称应含义清晰、明确。
3、所有命名都不易过长,应控制在规定的最大长度以内。
4、所有命名都应尽量使用全称。
5、如果命名使用缩写,则应该使用《通用缩写表》(见附录)中的缩写;原则上不推荐使用《通用缩写表》以外的缩写,如果使用,则必须对其进行注释和说明。
具体规范:
1、工程名:
不强制统一。
2、文件名:
·基于工程名,开头3个字母应表明与哪一个工程相关。
·后面的字母应能够区别不同的功能。
·不区分大小写。
·长度不限于8.3格式,建议不多于30个字符。
·若文件用于定义和实现类,建议文件名与类名保持一致。
3、函数名:
·参照 Windows API 的命名规范。
·推荐使用动宾结构。函数名应清晰反映函数的功能、用途。
·函数名最长不得超过30个字符。
·函数名第一个字母必须大写。
·全局函数必须以小写前缀"g"开头。
4、变量名:
原则上,变量名的命名遵从匈牙利记法。即:前缀 + 类型 + 变量名
1)格式:
[m_|s_|g_] type [class name|struct name] variable name
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: ft
·BYTE: by
·WORD: w
·DWORD: dw
·unsigned: u
·function: fn
·p :pointer
·lp :pointer
变量名最长不得超过20个字符。
5、类名:
·必须以大写"K"开头,后面字母反映具体含义,以清晰表达类的用途和功能为原则。
·接口必须以大写"I"开头,代表 Interface 。
·当名称由多个单词构成时,每一个单词的第一个字母必须大写。
6、结构名、宏名、枚举名、联合名:
·全部大写。
·枚举名加小写前缀"enum"。
例:
typedef enum _KFILE_OPEN_MODE
{
enumOPEN_READONLY = 0,
enumOPEN_READWRITE = 1,
enumCREATE_ALWAY = 3
} KFILE_OPEN_MODE;
//·宏名加小写前缀"def"。
例:
#define defMAXNUMBER 100
·结构名加小写前缀"tag",之后必须以大写"K"开头。
例:
typedef struct tagKPOINT
{
int x;
int y;
} KPOINT;
//·联合名加小写前缀"uni"。
例:
typedef union _VARIANT{
char unichVal;
int uninVal;
long unilVal;
float uniftVal;
...
} VARIANT;
C/C++源代码书写规范(试行)
1. 在.h/.cpp的开头应有一段格式统一的说明,内容包括:
a. 文件名 (FileName);
b. 创建人 (Creater);
c. 文件创建时间 (Date);
d. 简短说明文件功能、用途 (Comment)。
2. 除非极其简单,否则对函数应有注释说明。内容包括:功能、入口/出口参数,必要时还可有备注或补充说明。
3. 每行代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。
例:HANDLE KSOpenFile(const char cszFileName[],
int nMode);
或者:
BOOL KSReadFile(
HANDLE hFile,
void *pvBuffer,
int nReadSize,
int *pnReadSize
);
4. 循环、分支代码,判断条件与执行代码不得在同一行上。
例:正确:
if (n == -2)
n = 1;
else
n = 2;
不得写做:
if (n == -2) n = 1;
else n = 2;
5. 指针的定义,* 号既可以紧接类型,也可以在变量名之前。
例:可写做:int* pnsize;
也可写做:int *pnsize;
但不得写做:int * pnsize;
6. 在类的成员函数内调用非成员函数时,在非成员函数名前必须加上“::”。
7. 函数入口参数有缺省值时,应注释说明。
例:
BOOL KSSaveToFile(
const char cszFileName[],
BOOL bCanReplace /* = TRUE */
);
或者:
BOOL KSSaveToFile(
const char cszFileName[],
BOOL bCanReplace // = TRUE
);
8. else if 必须写在一行。
9. 与‘{’、‘}’有关的各项规定:
9.1‘{’、‘}’应独占一行。在该行内可有注释。
例:正确:
for (i = 0; i < cbLine; i++)
{ // .....
printf("Line %d:", i);
printf("%s/n", pFileLines);
}
不得写做:
for (i = 0; i < cb; i++)
{ printf("Line %d:", i);
printf("%s/n", pFileLines);
}
9.2‘{’必须另起一行,‘{’之后的代码必须缩进一个Tab。‘{’与‘}’必须在同一列上。
例:正确:
if (i > 0)
{
m = 1;
n++;
}
不得写做:
if (i > 0) {
m = 1;
n++;
}
例外:
if (i == 0)
{ ASSERT(FALSE); return; }
9.3 在循环、分支之后若只有一行代码,虽然可省略‘{’、‘}’,但不推荐这么做。若省略后可能引起歧义,则必须加上‘{’、‘}’。
例:正确:
if (n == -2)
n = 1;
else
n = 2;
或者:
if (n == -2)
{ n = 1; }
else if (n != nTemp)
{ n = 2; }
else
{ n = 3; }
不得写做:
if (n == -2)
n = 1;
else if (n != nTemp)
n = 2;
else
n = 3;
不推荐:
if (i < 1)
{ n = 1; }
else
{
if (i == 1)
{ n = 2; }
else
{
if (i > 1)
{ n = 3; }
}
}
10. 与空格有关的各项规定。
10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘.’、‘[’、‘]’等运算符前后,及‘&’(取地址)、‘*’(取值)等运算符之后不得有空格。
例:正确:
int n = 0, nTemp;
for (int i = nMinLine; i <= nMaxLine; i++)
不得写做:
int n=0, nTemp;
for ( int i=nMinLine; i<=nMaxLine; i++ )
10.2 for、while、if 等关键词之后应有1个空格,再接‘(’,之后无空格;在结尾的‘)’前不得有空格。
例:正确:
if (-2 == n)
不得写做:
if(-2 == n)
或
if ( -2 == n )
等等。
10.3 调用函数、宏时,‘(’、‘)’前后不得有空格。
例:正确:
printf("%d/n", nIndex);
不得写做:
printf ("%d/n", nIndex);
printf( "%d/n", nIndex );
等等。
10.4 类型强制转换时,‘(’‘)’前后不得有空格
例:可写做:
(KSFile*)pFile;
也可写做:
(KSFile *)pFile
不得写做:
( KSFile* )pFile
( KSFile * ) pFile
11. 与缩进有关的各项规定
11.1 缩进以 Tab 为单位。1 个 Tab 为 4 个空格
11.2 下列情况,代码缩进一个 Tab:
1. 函数体相对函数名及‘{’、‘}’。
例:
int Power(int x)
{
return (x * x);
}
2. if、else、for、while、do 等之后的代码。
3. 一行之内写不下,折行之后的代码,应在合理的位置进行折行。若有 + - * / 等运算符,则运算符应在上一行末尾,而不应在下一行的行首。
11.3 下列情况,不必缩进:switch 之后的 case、default。
例:
switch (nID)
{
case ID_PLAY:
......
break;
case ID_STOP:
......
break;
default:
......
break;
}
匈牙利命名法
MFC、句柄、控件及结构的命名规范
Windows类型
样本变量
MFC类
样本变量
HWND
hWnd;
CWnd*
pWnd;
HDLG
hDlg;
CDialog*
pDlg;
HDC
hDC;
CDC*
pDC;
HGDIOBJ
hGdiObj;
CGdiObject*
pGdiObj;
HPEN
hPen;
CPen*
pPen;
HBRUSH
hBrush;
CBrush*
pBrush;
HFONT
hFont;
CFont*
pFont;
HBITMAP
hBitmap;
CBitmap*
pBitmap;
HPALETTE
hPaltte;
CPalette*
pPalette;
HRGN
hRgn;
CRgn*
pRgn;
HMENU
hMenu;
CMenu*
pMenu;
HWND
hCtl;
CState*
pState;
HWND
hCtl;
CButton*
pButton;
HWND
hCtl;
CEdit*
pEdit;
HWND
hCtl;
CListBox*
pListBox;
HWND
hCtl;
CComboBox*
pComboBox;
HWND
hCtl;
CScrollBar*
pScrollBar;
HSZ
hszStr;
CString
pStr;
POINT
pt;
CPoint
pt;
SIZE
size;
CSize
size;
RECT
rect;
CRect
rect;
一般前缀命名规范
前缀
类型
实例
C
类或结构
CDocument,CPrintInfo
m_
成员变量
m_pDoc,
变量命名规范
前缀
类型
描述
实例
ch
char
8位字符
chGrade
ch
TCHAR
如果_UNICODE定义,则为16位字符
chName
b
BOOL
布尔值
bEnable
n
int
整型(其大小依赖于操作系统)
nLength
n
UINT
无符号值(其大小依赖于操作系统)
nHeight
w
WORD
16位无符号值
wPos
l
LONG
32位有符号整型
lOffset
dw
DWORD
32位无符号整型
dwRange
p
*
指针
pDoc
lp
FAR*
远指针
lpszName
lpsz
LPSTR
32位字符串指针
lpszName
lpsz
LPCSTR
32位常量字符串指针
lpszName
lpsz
LPCTSTR
如果_UNICODE定义,则为32位常量字符串指针
lpszName
h
handle
Windows对象句柄
hWnd
lpfn
callback
指向CALLBACK函数的远指针
?
应用程序符号命名规范
前缀
符号类型
实例
范围
IDR_
不同类型的多个资源共享标识
IDR_MAIINFRAME
1~0x6FFF
IDD_
对话框资源
IDD_SPELL_CHECK
1~0x6FFF
HIDD_
对话框资源的Help上下文
HIDD_SPELL_CHECK
0x20001~0x26FF
IDB_
位图资源
IDB_COMPANY_LOGO
1~0x6FFF
IDC_
光标资源
IDC_PENCIL
1~0x6FFF
IDI_
图标资源
IDI_NOTEPAD
1~0x6FFF
ID_
来自菜单项或工具栏的命令
ID_TOOLS_SPELLING
0x8000~0xDFFF
HID_
命令Help上下文
HID_TOOLS_SPELLING
0x18000~0x1DFFF
IDP_
消息框提示
IDP_INVALID_PARTNO
8~0xDEEF
HIDP_
消息框Help上下文
HIDP_INVALID_PARTNO
0x30008~0x3DEFF
IDS_
串资源
IDS_COPYRIGHT
1~0x7EEF
IDC_
对话框内的控件
IDC_RECALC
8~0xDEEF
?
Microsoft MFC宏命名规范
名称
类型
_AFXDLL
唯一的动态连接库(Dynamic Link Library,DLL)版本
_ALPHA
仅编译DEC Alpha处理器
_DEBUG
包括诊断的调试版本
_MBCS
编译多字节字符集
_UNICODE
在一个应用程序中打开Unicode
AFXAPI
MFC提供的函数
CALLBACK
通过指针回调的函数
库标识符命名法
标识符
值和含义
u
ANSI(N)或Unicode(U)
d
调试或发行:D = 调试;忽略标识符为发行。
静态库版本命名规范
库
描述
NAFXCWD.LIB
调试版本:MFC静态连接库
NAFXCW.LIB
发行版本:MFC静态连接库
UAFXCWD.LIB
调试版本:具有Unicode支持的MFC静态连接库
UAFXCW.LIB
发行版本:具有Unicode支持的MFC静态连接库
动态连接库命名规范
名称
类型
_AFXDLL
唯一的动态连接库(DLL)版本
WINAPI
Windows所提供的函数
Windows.h中新的命名规范
类型
定义描述
WINAPI
使用在API声明中的FAR PASCAL位置,如果正在编写一个具有导出API人口点的DLL,则可以在自己的API中使用该类型
CALLBACK
使用在应用程序回叫例程,如窗口和对话框过程中的FAR PASCAL的位置
LPCSTR
与LPSTR相同,只是LPCSTR用于只读串指针,其定义类似(const char FAR*)
UINT
可移植的无符号整型类型,其大小由主机环境决定(对于Windows NT和Windows 9x为32位);它是unsigned int的同义词
LRESULT
窗口程序返回值的类型
LPARAM
声明lParam所使用的类型,lParam是窗口程序的第四个参数
WPARAM
声明wParam所使用的类型,wParam是窗口程序的第三个参数
LPVOID
一般指针类型,与(void *)相同,可以用来代替
- 抨击匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法收藏
- 匈牙利命名法
- 关匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法收藏
- "匈牙利"命名法
- 匈牙利命名法
- 匈牙利命名法收藏
- 匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法
- 匈牙利命名法
- 附录 匈牙利命名法
- C++学习笔记-后台服务程序开发模式
- 并发编程,已成必要
- CTrueColorToolBar的使用
- 用Delphi实现将纯文本资料转入数据库
- VC6.0 无法安装的问题
- 匈牙利命名法
- 追求~!
- 从《亮剑》之李云龙看4E管理者
- CFile 和 CStdioFile 区别以及 CString 中的 '/r/n'
- 如何定义项目目标
- DoDataExchange 函数简单说明
- 软件开发活动评估需要考虑的问题
- 绑定HGE到AngelScript脚本系统
- mysql升级到5.x版本