C++代码规范的注意

关于注释:

1.注释//后面要空一格

2.if,else的注释可以写在里面,注明做什么事.

3.注释前最好空一行,不显得太拥挤 4.简单的代码不用注释,多余

 

关于空行:

1.不同的模块之间需要空行

2.定义了变量下面模块要使用.不能加空行

 

注意:

变量的命名尽量要有意义让人看得懂

在使用GetFileAttribute判断文件属性的时候,可以用  例如:(FILE_ATTRIBUTES_DIRECTORY & GetFileAttribute(....)) == FILE_ATTRIBUTES_DIRECTORY

只有BOOL 类型的值才可以用"!"   不能乱用

之前用过 szStr != "" ,这种用法容易误解且不直观.应该使用 !szStr.empty()

变量定义在要使用之前

 

变量命名规范:

Type	Prefix	Example	Comment
Member Variables	m_	m_hThread	member
Static Variables	s_	s_bLastValue	static
Global Variables	g_	g_sockRecv	global
* (point)	p	pszFileName
* (long point)	lp	lpszFileName
char	c	cSign	char
char	p	pBuffer	pointer to a buffer or memory
char	psz	pszWkspDir	poingter to a string end with zero
int, short, long…	n	nCount
UINT, unsigned int	ui	uiRet
USHORT, unsigned short	us	usWaveData
bool, BOOL	b	bSuccessful
float	f	fValue
double	db	dbValue
BYTE	by	byImageSize
WORD	w	wCode
DWORD	dw	dwTick
HANDLE	h	hWnd	HWND, HINSTANCE…
COLORREF	clr	clrBorder
socket	sock	sockSend
CString	sz	szModuleName	string end with zero
CFile	file	fileLog
CFileFind	finder	finder
CWnd	wnd	wndToolbar	IDW_
CDialog	dlg	dlgLogin	IDD_
CView	view	viewChild
CMenu	menu	menuMain	IDM_
CButton	btn	btnOK	IDC_BTN_
CStatic	static	staticText	IDC_STATIC_
CEdit	edit	editTime	IDC_EDIT_
CRichEditCtrl	redit	reditMessage	IDC_REDIT_
CComboBox	combo	comboUsername	IDC_COMBO_
CListBox	listbox	listboxDate	IDC_LISTBOX_
CListCtrl	list/listctrl	listInfo	IDC_LIST_
CTreeCtrl	tree	treeMap	IDC_TREE_
CTabCtrl	tab	tabOption	IDC_TAB_
CSliderCtrl	slider	sliderHue	IDC_SLIDER_
CSpinButtonCtrl	spin	spinCount	IDC_SPIN_
CProgressCtrl	prog	progSetup	IDC_PROG_
CBitmap	bmp	bmpBkgnd
CBrush	br	brFrgnd
CPen	pen	penSolid
CFont	font	fontOld
CDC	dc	dcMem
CPoint	pt/point	ptClicked
CRect	rc/rect	rcClient
CSize	size	sizeImage
CTime	t/time	tCurrent
CArray	arr	arrKeyNames	KeyNamesArray
CList	lst	lstEvents	EventsList
CMap	map	mapKey2Value	Key2ValueMap
string	str	strTemp	maybe not end with zero
vector	vct/arr	vctStations	StringVector / StringArray
list	lst	lstBookmarks	StringList
map	map	mapKey2Value	Key2ValueMap
iterator	It/itr	itr
enum	I	IThreadStatus
struct	T	TUserInfo
class	C	CModalDlg