好的格式让人感到代码的整洁,一致及所感知到的对细节的关注而震惊。保持良好的代码格式,选用一套管理代码格式的简单规则,然后贯彻这些规则。
格式的目的:
代码格式关乎沟通,增加代码的可读性垂直格式
关系密切的概念应相互靠近。
变量声明 变量声明应尽可能靠近其使用位置
实体变量 应该在类的顶部声明
相关函数 某个函数调用了另一个函数,将他们放一起,调用者应尽可能在被调者的上方向报纸学习 名称应该简单且一目了然。内容短小精悍
概念间垂直方向上的区隔
从上往下,从左往右,每一行一个表达式,每组代码展示一条完整的思路,这些思路用空白行区隔开来垂直方向上的靠近
拥有紧密关系的代码行应相互靠近。垂直距离
函数之间会调用,如果函数距离相隔甚远,你没有办法去理解函数关系,系统的功能。
关系密切的概念应该相互靠近。他们之间的区隔应该成为对相互的易懂度有多重要的衡量标准。应避免迫使读者在源文件和类中跳来跳去。
6.1 变量声明 应尽可能靠近其使用位置;短小函数 本地变量应在函数顶部出现
6.2 实体变量 应在类的顶部声明。
6.3 相关函数 函数A调用了函数B,应将他们放在一起,A在B的前面
6.4 概念相关 概念相关的代码应该放在一起。相关性越强,彼此之间的距离就该越短。垂直顺序 被调用的函数应该放在执行调用的函数下面
横向格式
一行代码应该多宽。一行代码太长阅读起来不如人意,太短造成句意感觉上的分割。上限应在80左右(120)。水平方向上的区隔与靠近 空格的使用
乘除运算项不加空格,加减之间加空格,以体现优先级水平对齐 不用让变量的修饰符、类型、名称上下对齐,不易阅读
缩进 即使短小的if、while或小函数也应缩进。
空范围 当while、for语句没有方法体时,也应用{}表示。易于阅读
团队规则
开发团队应具有同样的编码风格