代码规范制定

代码规范制定

• 缩进
    缩进一般为4个空格，平时可使用TAB键来进行缩进

• 变量命名
    1.标识符命名
  命名尽量使用英文单词，力求简单清楚 ，避免使用引起误解的词汇和模糊的，使人产生误解。
    2.命名规范必须与所使用的系统风格保持一致，并在同一项目中统一。可采用全小写加下划线的风格或大小写混排的方式，但不能使用大小写与下划线混排的方式。
    3.变量的命名可参考“匈牙利”标记法（Hungarian Notation）：TypePrefix+Name
    4.建议：枚举类型 enum常量应以大写字母开头或全部大写。
    5.命名中若使用了特殊约定或缩写，则要有注释说明。

• 每行最多字符数
    1.较长的语句（>80 字符）要分成多行书写）要分成多行书写。
    2.长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。
    3.循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

• 函数最大行数
    函数的规模尽量限制在 100 行以内。

• 函数、类命名
    1.函数名采用谓-宾结构（动-名），且应反映函数执行什么操作以及返回什么内容。
    2.模板名采用全大写的方式，每个单词间用下划线分隔。

• 常量
    1.常量、宏采用全大写的方式，每个单词间用下划线分隔。

• 空行规则
    1.函数之间应该用空行分开；
    2.用空行将代码按照逻辑片断划分；
    3.每个类声明之后应该加入空行同其他代码分开。

• 注释规则
    注释应该和代码同时更新，不再有用的注释要删除，不再有用的注释要删除。注释的内容要清楚、明了，不能有二义性 ，不能有二义性。
    1.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
    2.注释与所描述内容进行同样的缩排。
    3.将注释与其上面的代码用空行隔开。
    4.变量、常量、宏的注释应放在其上方相邻位置或右方。
    5.对于所有有物理含义的变量、常量，如果其命名不是充分自注释的 ，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义 ，说明其物理含义。
    6.数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释可放在此域的右方。
    7.对重要变量的定义需编写注释，特别是全局变量，更应有较详细的注释，包括对其功能、取值范围、以及存取时注意事项等的说明。

• 操作符前后空格
    1.值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“ =”、“ +=”、“ >=”、“ <=”、“ +”、“ *”、“ %”、“ &&”、“ ||”、“ <<” 、“ ^” 等二元操作符的前后应当加空格。
    2.一元操作符如“ !”、“ ~”、“ ++”、“ --”、“ &”（ 地址运算符） 等前后不加
  空格。
    3.像“［ ］”、“ .”、“ ->” 这类操作符前后不加空格。

• 其他规则
    1.一行代码只做一件事情，如只定义一个变量，或只写一条语句。
    2.if、for、do、while、case、switch、default default default 等语句自占一行等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号等语句的执行语句部分无论多少都要加括号{}。