当有人查看底层代码实现时,我们希望他们为其整洁、一致及所感知到的对细节的关注而震惊。
如果在团队中工作,那么团队应该一致同意采用一套简单的格式规则,所有成员都要遵从,使用能帮你应用这些格式规则的自动化工具会很有帮助。
代码格式很重要
- 抛掉“让代码能工作是头等大事”的想法
- 功能可能被修改,代码的可读性会对以后可能发生的修改行为产生深远影响。
格式:
- 短文件通常比长文件更易于理解
- 列出一个好的“报纸头条”(源文件的名称)
- 用空白行区隔开魅族代码行所展示的思路
- 紧密相关的代码应该互相靠近
- 上面那条规则并不适用于分布在不同文件中 的概念,尽量不要把关系密切的概念放在不同的文件中。
变量声明
变量声明应该靠近其使用位置。
- 因为函数很短,本地变量应该在函数的顶部出现。
- 循环中的控制变量应该总是在循环语句中声明
- 实体变量应该在类的顶部声明。
相关函数
若相关函数调用了另外一个,就应该把它们放在一起,而且调用者应该近可能放在被调用者上面。
概念相关
概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短。
垂直顺序 - 被调用的函数应该放在执行调用函数的下面