【《代码整洁之道》精读与演绎】之四 优秀代码的格式准则

这篇文章将与大家一起聊一聊，书写代码过程中一些良好的格式规范。

一、引言

以下引言的内容，有必要伴随这个系列的每一次更新，这次也不例外。

 

 

但我们知道，很多时候，理想很丰满，现实很骨感，也知道人在江湖，身不由己。因为项目的紧迫性，需求的多样性，我们无法时时刻刻都写出整洁的代码，保持自己输出的都是高质量、优雅的代码。

 

但若我们理解了代码整洁之道的精髓，我们会知道怎样让自己的代码更加优雅、整洁、易读、易扩展，知道真正整洁的代码应该是怎么样的，也许就会渐渐养成持续输出整洁代码的习惯。

 

而且或许你会发现，若你一直保持输出整洁代码的习惯，长期来看，会让你的整体效率和代码质量大大提升。

 

 

再看个正面示例（代码段2）：

以上这段正面示例（代码段2）比反例（代码段1）中的代码好太多，它正好一览无遗，一眼就能看这个是有两个变量和一个方法的类。而再看看反例，注释简直画蛇添足，隔断了两个实体变量间的联系，我们不得不移动头部和眼球，才能获得相同的理解度。

6 基于关联的代码分布

关系密切的概念应该相互靠近。对于那些关系密切、放置于同一源文件中的概念，他们之间的区隔应该成为对相互的易懂度有多重要的衡量标准。应该避免迫使读者在源文件和类中跳来跳去。变量的声明应尽可能靠近其使用位置。

对于大多数短函数，函数中的本地变量应当在函数的顶部出现。例如如下代码中的is变量的声明：

而循环中的控制变量应该总在循环语句中声明，例如如下代码中each变量的声明：

在某些较长的函数中，变量也可能在某代码块的顶部，或在循环之前声明。例如如下代码中tr变量的声明：

另外，实体变量应当在类的顶部声明（也有一些流派喜欢将实体变量放到类的底部）。

若某个函数调用了另一个，就应该把它们放到一起，而且调用者应该尽量放到被调用者上面。这样，程序就有自然的顺序。若坚定地遵守这条约定，读者将能够确信函数声明总会在其调用后很快出现。

概念相关的代码应该放到一起。相关性越强，则彼此之间的距离就该越短。

 

这一节的要点整理一下，大致就是：

• 变量的声明应尽可能靠近其使用位置。
• 循环中的控制变量应该在循环语句中声明。
• 短函数中的本地变量应当在函数的顶部声明。
• 而对于某些长函数，变量也可以在某代码块的顶部，或在循环之前声明。
• 实体变量应当在类的顶部声明。
• 若某个函数调用了另一个，就应该把它们放到一起，而且调用者应该尽量放到被调用者上面。
• 概念相关的代码应该放到一起。相关性越强，则彼此之间的距离就该越短。

 

7 团队遵从同一套代码规范

 

一个好的团队应当约定与遵从一套代码规范，并且每个成员都应当采用此风格。我们希望一个项目中的代码拥有相似甚至相同的风格，像默契无间的团队所完成的艺术品，而不是像一大票意见相左的个人所堆砌起来的残次品。

定制一套编码与格式风格不需要太多时间，但对整个团队代码风格统一性的提升，却是立竿见影的。

记住，好的软件系统是由一系列风格一致的代码文件组成的。尽量不要用各种不同的风格来构成一个项目的各个部分，这样会增加项目本身的复杂度与混乱程度。

 

声明：本站部分文章及图片源自用户投稿，如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢！