格式

PPG007 ... 2021-12-26 About 1 min

# 格式

# 格式的目的

代码也是一种沟通,好的格式能让沟通更加顺畅。

# 垂直格式

  • 源文件要像报纸文章那样,名称简单且一目了然,最上方给出概念和算法,细节向下逐次展开。
  • 使用空白行将不同思路、逻辑的代码区分隔开。
  • 紧密相关的代码行应该互相靠近,相关性越强就越近,中间不应出现空行或注释等分隔。
  • 变量声明应当尽量靠近使用处。
  • 实体变量应该声明在类的顶部。
  • 如果两个函数出现了相互调用,那么他们应当放到一起,且调用者应当尽可能放在被调用者的上面。

# 横向格式

  • 一行代码不应过长。
  • 相关性较弱的内容应当远离,例如运算符的两个操作数和符号间应该分别有一个空格,而函数名和左括号应当不加空格。
  • 对齐?。
  • 合理的缩进。
  • while、if等语句如果没有代码体依然应当加上括号,不要只在末尾添加一个分号。

# 团队规则

每个成员应当采用同一种格式风格。

Last update: December 26, 2021 13:38
Contributors: PPG007