当有人查看底层代码实现时,我们希望他们为其整洁、一致及所感知到的对细节的关注而感到震惊。我们应该保持良好的代码格式,选择一套管理代码格式的简单规则,然后贯穿这些规则。如果在团队中工作,则团队应该一致同意采用一套简单的格式规则,所有成员都要准从。
一、垂直格式
像报纸那样,我们的代码也应该重上到下,层层递进,细节往下渐次展开,给人一种像读报纸一样,内容短小精悍,次序谨然。
1、使用空白行进行概念间垂直方向上的区隔,不同概念的代码使用空白行进行逻辑划分
2、垂直方向上的靠近,概念相关的代码应该放到一起,相关性越强,彼此之间的距离就应该越短
3、垂直距离,本地变量声明应该在函数的顶部出现、循环中的控制变量应该总是在循环语句中声明、实体变量应该在类的顶部声明、被调用函数应该和调用者在一起
4、垂直顺序,我们应该自上而下展示函数调用依赖顺序,被调用的函数应该放到调用执行的函数下面。
二、横向格式
应该尽量保持代码行短小,保证每行的字符数最多在80到120之间,可以考虑以无需拖动横向滚动条为原则。
1.水平方向的区隔与靠近,是用空格将彼此紧密相关的事物联系到一起,也用空格将相关性较弱的事物隔开
2.水平对齐
3.缩进,类中的方法相对于该类缩进一个层级,方法的实现相对于方法缩进一个层级,代码块的实现相对于其容器代码块缩进一个层级,以此类推。
三、团队规则
如果在一个团队中进行开发工作,请在开发前,制定一套所有人都认同的开发规则,然后在个人风格与团队规则之间,矢志不渝的准守团队规则,以保障项目的整体风格