软件工程课程设计采用的VSS注释

/*******************************************************************
*
*文 件 名： $Workfile: 语音传输重构.cpp $
*
*程 序 员： $Author: Globe $
*
*描 述：
*
*最后修改时间：$Modtime: 05-03-23 7:54p $
*
*修 订 次 数： $Revision: 0 $
*
*修 订 记 录： $History: 语音传输重构.cpp $
*
*******************************************************************/

文件开头的注释模板（建议用SourceSafe自动生成里面的大部分信息，具体见目录：李欲版本控制软件(看里面的readme)）

/*******************************************************************

*

*文 件 名：

*

*程 序 员：

*

*描 述：

*

*最后修改时间：

*

*修 订 次 数：

*

*修 订 记 录：

*

*******************************************************************/

变量命名规范-----采用匈牙利命名法：

匈牙利命名法通过在变量名前面加上相应的小写字母的符号标识作为前缀，标识出变量的作用域，类型等。这些符号可以多个同时使用，顺序是先m_（成员变量），再指针，再简单数据类型，其他。例如：m_lpszStr, 表示指向一个以0字符结尾的字符串的长指针成员变量。
匈牙利命名法关键是：标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。

强烈建议大家都采用前两个表作为我们的编码规范，方便大家看代码和帮忙找错误。其它就结合大家的习惯了，但需要在变量名中体现比变量类型和变量意义。

一般前缀命名规范

前缀	类型	实例
C	类或结构	CDocument，CPrintInfo
m_	成员变量	m_pDoc，m_nCustomers
g_	全局变量(尽量不要用)	g_nMsg, g_bFlag

变量命名规范

前缀	类型	描述	实例
ch	char	8位字符	chGrade
sz	char *	字符指针，即字符串	szName
b	BOOL	布尔值	bEnable
n	int	整型（其大小依赖于操作系统）	nLength
n	UINT	无符号值（其大小依赖于操作系统）	nHeight
w	WORD	16位无符号值	wPos
l	LONG	32位有符号整型	lOffset
dw	DWORD	32位无符号整型	dwRange
p	*	指针	pDoc
ch	TCHAR	如果_UNICODE定义，则为16位字符	chName
lp	FAR*	远指针	lpszName
lpsz	LPSTR	32位字符串指针	lpszName
lpsz	LPCSTR	32位常量字符串指针	lpszName
lpsz	LPCTSTR	如果_UNICODE定义，则为32位常量字符串指针	lpszName
h	handle	Windows对象句柄	hWnd
lpfn	callback	指向CALLBACK函数的远指针	LpfnName
str	CString	MFC中常用的字符串类型	strName

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；
var kevent = 'onabort|onblur|onchange|onclick|ondblclick|onerror|onfocus|onkeydown|onkeypress|onkeyup|onload|onmousedown|onmousemove|onmouseout|onmouseover|onmouseup|onreset|onresize|onselect|onsubmit|onunload'; var aevent = kevent.split('|'); jQuery('.showContent img').each(function(){ var nimg = this; jQuery.each(aevent, function(i, n){ if (n!='onload') { jQuery(nimg).attr(n, ''); } else { if (jQuery(nimg).attr(n) != 'if(this.width>650) this.width=650;') { jQuery(nimg).attr(n, ''); } } }); }); 0人 了这篇文章 类别： 编程人生┆阅读( 0)┆评论( 0) ┆ 返回博主首页┆ 返回博客首页 上一篇 cppunit 在vc6.0下的安装和使用 下一篇 走了，离开机房 职位推荐 测试开发工程师 测试工程师 探针测试 高级软件测试工程师 高级测试工程师 软件测试工程师 测试工程师 测试工程师 软件测试 软件测试工程师 文章评论   [1楼]        小王  回复 2008-06-11 08:25:47 文章很不错，也欢迎博主访问我的技术blog： http://xiaowang.blog.51cto.com   发表评论             昵  称： 登录  快速注册 验证码： 点击图片可刷新验证码请点击后输入验证码博客过2级，无需填写验证码 内  容： 同时赞一个 每日博报 精彩不止一点 Copyright By 51CTO.COM 版权所有