实习记录-代码规范

一、常见命名方法介绍：

1. 匈牙利命名法（属性＋类型前缀＋描述性单词）

例如：int m_iAge\Vector g_vecName
常见属性：
g_ 全局变量 m_类成员变量 s_静态变量 c_常量

2. 驼峰命名法（第一个单词小写，余下的单词首字母大写）

例如：myName、printEmployeePaychecks()

3. 帕斯卡命名法，也有人称为 大驼峰命名法（第一个字母大写）

例如：UserName、DisplayInfo

4. 下划线命名法（单词与单词间用下划线分开）

例如：int user_age、void get_user_name()、#define SYSTEM_USER_NAME XXX

5. 下划线命名法（单词与单词间用下划线分开）

例如：int user_age、void get_user_name()、#define SYSTEM_USER_NAME XXX

二、习惯性变量和函数命名规则

函数命名 帕斯卡命名法、宏定义 下划线命名法、变量命名 匈牙利命名法

三、代码格式

1.一行只写一句
2.程序块必须缩进（缩进的空格数为4个，对齐只能用空格不能用TAB）
3.合理使用空行（注意：行尾空行要去除）
4.较长的表达式或语句要适当换行（操作符要放在新行之首）
5.关键字独占一行
6.分界符应独占一行且对齐
7.操作符等符号的前后空格问题
8.预处理不要缩进

四、变量相关规范

1.变量必须初始化
2.公共变量应该对其含义、作用及取值范围进行注释说明
3.去掉没必要的公共变量
4.对于公共变量可以构造一个模块进行统一创建、修改和读取
5.尽量减少没必要的数据类型默认转换和强制转换

五、宏相关规范

1.用表达式时，要使用完备的括号
2.宏定义的多条表达式放在大括号中
3.使用宏时，不允许参数发生变化

六、注释（单行用//,多行用/**/）

1.修改代码同时修改响应的注释
2.数据结构的命名如果不是充分自注释的，必须加以注释（对数据结构的注释应该在上方，对结构中的每个域应该放在右方）
3.注释跟所描述的内容进行同样的缩排
4.对变量的定义和分支语句（if条件分支、while循环语句等）必须编写注释

七、说明性文件（头文件）注释规则

1.注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等、头文件的注释中还应有函数功能简要说明。此外，头文件的代码需要分块，以区分include、宏常亮、宏函数、结构、类、全局变量、全局函数声明
2.函数的头部应进行功能注释（函数的目的/功能、输入参数、输出参数、返回值、调用关系等）