codestyle.md

代码风格

• 缩进

  1. 如果开发工具可以设置，则统一设置缩进为四个空格。
  2. 当一行代码划分为两行或多行时，要缩进对齐。

• 变量命名

  1. 循环变量指定使用i,j,k。
  2. 其他变量采取驼峰命名法命名。

• 每行最多字符数

  1. 单行字符限制不超过120个，超出需要换行，且遵循以下规则
     • 第二行相对于第一行缩进四个空格，从第三行开始，不在继续缩进
     • 运算符与下文一起换行。
     • 方法调用的点符号与下文一起换行。
     • 在多个参数超长，都好后进行换行。
     • 在括号前不要换行。

• 函数

  1. 函数最大的行数应该尽量维持在100行内（不包括注释行），超出过多则审视函数是否内部有可重构部分，有则提出重构为新的函数，使主函数代码更加清晰。
  2. 一个函数仅完成一件功能。

• 函数和类的命名

  1. 函数的命名遵循驼峰命名规则命名。
  2. 类的命名则遵循帕斯卡命名法命名。

• 常量

  1. 常量的命名用大写字母或者下划线连接多个单词的大写字母表示，例如MAX_VALUE。

• 空行规则

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

• 注释规则

  1. 源文件头部应该进行注释，列出生产日期，作者，模块功能等信息。
  2. 函数头部应进行注释，列出函数的功能，输入参数，输出参数，返回值等。
  3. 对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以释，说明其物理含义。
  4. 注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。
  5. 注释与所描述内容进行同样的缩排
  6. 将注释与其上面的代码用空行隔开。
  7. 变量、常量、宏的注释应放在其上方相邻位置或右方。
  8. 注释也要实时更新，没用的注释要及时删减。
  9. 注释要清晰简洁。

• 操作符前后空格

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

• 其他规则

  暂无