学习日志1---运用匈牙利命名法的命名规范，以及注释规范

记录下来方便查阅，用于C++编程

---

命名规范

---

1.变量命名

前缀 表示类型 例子 a 数组 aScore[50] b 波尔变量 bFlag c 字符变量 cSex i或n 整形变量 iNum, nNum ui 无符号整形变量 uiStart, uiPos sz或str 以零结尾的字符串变量 szMyName, strMyName p 指针变量 pszString, pMyDlg h 句柄 hWnd, hPen, hDlg m_ 类的成员变量 m_xStart C 类和结构 CDialo, Cview, CmysdiApp, CRuntimeClass ID*_ 资源标识 ID_ , IDD_ , IDC_ , IDB_ , IDI_ g_ 全局变量 g_nMsg, g_bflag

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

---

2.常量与宏命名

1. 常量和宏的定义具有实际意义
2. 定义在#include和函数之前
3. 使用大写字母，根据意义的连续性用下划线连接
4. 定义的右侧写注释

---

3.控件命名

前缀 表示类型 例子 btn 按钮 m_btnTest stat 静态文本框 m_startMessage edit 编辑框 m_editName lst或lc 列表框 m_lstLog, m_lcLog rd 单选框 rd_Background cb 组合框 cb_cbSex ip ip控件 m_ipServer dt 日期控件 m_dtStart wnd 窗口 m_wndSetting

---

4.资源命名

• 全部要求大写

各资源如下：

1. 菜单：IDM_XX / CM_XX
2. 位图： IDB_XX
3. 对话框：IDD_XX
4. 字符串：IDS_XX
5. 对话框下面控件：IDC_控件标签_控件描述 如：IDC_EDIT_YEAR, IDC_BUTTON_SUBMIT, IDC_COMBOX_CLASS

---

5.函数命名

• 大写字母开头，大小写字母组合，必要课下划线间隔，应进行功能作用描述， 如：void PrintTrackData();

---

6.类命名

• “C” 开头， 使用名词或名词性词组，如： CUserInfo

---

7.文件命名

• 文件名有实际意义
• 只能包含字母，数字，下划线
• 名字过长应当缩写
  
  • 缩写方法：
    
    1. 一般去掉无意或不发音字母
    2. 单词首字母一般保留
    3. 某一单词必须被缩成一个字母时，应选取最具代表性的字母或首字母
    4. 临时文件必须调用系统函数成，禁止使用固定文件名，一般情况下，临时文件应在系统临时目录下（通过系统取到临时目录名）生成。

---

8.参数命名

• 遵循和变量命名一样的规则

---

注释规范

---

1.函数注释

/**********************************
[函数名称] （必需）
[函数功能] （必需）
[参数] （必需。表明各参数是输入参数还是输出参数）
[返回值]（必需。解释返回值的意义）
**********************************/

---

2.类的注释

/**********************************
[类名]（必需）
[功能]（必需）
**********************************/

---

3.文件注释

在头文件、实现文件的首部，要有文件注释介绍内容

/**********************************
[文件名]（必需）
[功能模块和目的]（必需）
**********************************/

---

4.代码注释

• 除文件、函数注释允许 ‘/**/’ 外，其他单行注释或语句体的注释必须使用 ‘//’注释。
• 常量定义时应有说明
• 主要变量（结构，联合，类或对象）定义或引用是，要对含义进行注释
• 典型算法前注释
• 注释可在上一行
• 空行和空白符也是注释，对于一个函数内的功能模块用空行分割

---