格式

一个团队应该一致同意采用同一套的格式规则

格式的目地

  1. 代码格式关乎沟通,而沟通是专业开发者的头等大事

垂直格式

  1. 像报纸一样的,有上而下,由左而右
  2. 长度尽量要短,高于200行,少于500行为好的原则,当然也可以更短,短文件比长文件更容易理解

概念间垂直方向的区隔

  1. 在封包,导入声明和每个函数之间,都有空白行隔开

垂直方向上面的靠近

  1. 靠近行的代码暗示了他们之间的紧密联系,紧密代码相互靠近

垂直距离

  1. 关系紧密的关系要靠近,这条规则不适用于不同文件中的概念,除非有足够理由,否则不要把关系密切的概念放到不同文件中
  2. 变量声明:应该尽可能靠近其使用的位置,短小的函数应当放到头部
  3. 循环中的控制变量总在循环语句中声明
  4. 实体变量应该在类的顶部声明,良好的设计中会在很多方法中使用
  5. 实体变量c++中采用“剪刀原则”,但是在java中则放到最上面
  6. 相关函数:若某个函数调用了另外一个,就应该把它们放在一起
  7. 概念相关:概念相关的代码放到一起,相关性越强,彼此之间的距离就应该更短
  8. 垂直顺序:自向而下

横向格式

  1. 横向代码长度一般不能超过100或者120个字符,再多就不好了

水平方向上的区隔与靠近

  1. 使用空格字符将彼此相关的事物连接到一起
  2. 不在函数名和左圆括号之间加空格

     getName(int a, int b, int c);
    
  3. 乘法因子之间没有空格式

     b*b - 4*a*c 可以看到乘法优先级大于加减法
    

水平对齐

缩进

  1. 类声明不缩进
  2. 方法实现相对方法声明缩进
  3. 不要违反缩进规则
  4. 空范围不要使用

团队规则

[warning] 团队规则时最重要的,个人不得逾越到团队之上

results matching ""

    No results matching ""