一段赏心悦目的代码，将给一起工作的小伙伴们更好的心情

第一原则：像报纸一样一目了然。优秀的源文件也要像报纸文章一样，名称应当简单并且一目了然，名称本身应该足够告诉我们是否在正确的模块中。源文件最顶部应该给出高层次概念和算法。细节应该往下渐次展开，直至找到源文件中最底层的函数和细节。

第二原则：恰如其分的注释。带有少量注释的整洁而有力的代码，比带有大量注释的零碎而复杂的代码更加优秀。

第三原则：合适的单文件行数。尽可能用几百行以内的单文件来构造出出色的系统，因为短文件通常比长文件更易于理解。

第四原则：合理地利用空白行。在每个命名空间、类、函数之间，都需用空白行隔开。

第五原则：让紧密相关的代码相互靠近。靠近的代码行暗示着他们之间的紧密联系。所以，紧密相关的代码应该相互靠近。

第六原则：基于关联的代码分布。

 

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

 

第七原则：团队遵从同一套代码规范。一个好的团队应当约定与遵从一套代码规范，并且每个成员都应当采用此风格。

摘自：http://blog.csdn.net/poem_qianmo/article/details/52268975

转载于:https://www.cnblogs.com/xykj024/p/5795714.html