注释与变量命名

关于注释

  接触过C或者C++都会知道有单行注释（//）和成对注释（/**/）两种类型的注释。关于注释的重要性的问题，我就不再多说了。这里简单说说写注释的技巧和要注意的事项。

 1)成对注释（/**/）一般用于多行注释，这里需要强调的一个良好编程习惯是，在注释的每一行以星号开始，指明整个范围是多行注释的一部分，如下：

  

太多的注释混入程序代码会降低程序的可读性，通常最好是将一个注释块放在所解释代码的上方。

 

在此注释后面进行函数定义

2)注释对不可嵌套

 注释总是以/*开始以*/结束。一个注释对不能出现在另一个注释对中！

 原因：如果那段代码已经有了注释对，那么新插入的注释对将提前终止，如下图

 

  很显然这不是我们想要的结果。

编程好习惯提示：

关于变量命名

命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fgh表示连续意义字符串.

前缀        表示的类型 例    子

a      数组变量       aScore[50]

b      布尔变量       bFlag，bIsEnd

c      字符变量        cSex

i      整形变量        iNum

ui      无符号整形变量       uiStart，uiPos

sz      以0结束的字符串变量    szMyName

p      指针变量    pszString，pMyDlg

h      句柄        hWnd，hPen，hDlg

m_      类的成员变量    m_xStart

C      类和结构           CDialog，CView，CMysdiApp，CRuntimeClass

ID*_      资源标识    ID_，IDD_，IDC_，IDB_，IDI_

g_       全局变量    g_nMsg, g_bFlag

 

局部变量中可采用如下几个通用变量：   nTemp，nResult,index