software camp——编程规范:排版
原则:团队应遵守一致的排版风格
规则1:在不同的概念之间,增加空行
比如方法与方法、类名与import、import与包名之间、相对独立的程序块之间、变量说明后需增加空行,来提升可读性。
规则2:将逻辑紧密相关的代码放在一起
将相关的代码放在一起,阅读代码时能一眼获取相关信息,避免概念的频繁切换。其他还比如:将常量的定义放在一起,将有调用关系的代码尽量放在一起。
规则3:控制一行的宽度,不要超过120个字符
代码行长度越短,越容易理解。代码行太长,需要折行。折行时应注意语意流畅性,在低优先级操作符处划分新行,划分出的新行要进行适当的缩进,使排版整齐。
规则4:控制一行的宽度,在不同的概念间(关键字、变量、操作符等)增加空格,以便清楚区分概念
增加空格,其本质是区分概念,将逻辑相关紧密的部分凸现出来。具体来说在关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.)和括号,前后不加空格。
规则5:控制采用缩进来区分不同层次的概念
我们采用缩进来区分不同层次,展现代码的层次关系结构,让代码更容易阅读。每加一层大括号,就要加一层缩进。
对齐只使用空格键,不使用Tab键。
建议1:将局部变量的作用域最小化
变量的声明应该尽可能靠近变量第一次使用的位置。循环变量的定义应该在循环体的内部,不应该定义在循环体外。
建议2:if,for,do,while,case,switch,default等语句自行占一行,且if,for,do,while等语句的执行语句无论多少都要加括号{}
即使执行语句只有一条,也应该加括号。
建议3:控制文件的长度,最好不要超过500行
很多开源项目都表明,文件长度越短,越容易理解和维护。