Clean Code(代码整洁之道)-格式

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接: https://blog.csdn.net/ldc9001/article/details/87096918

    代码格式很重要,代码的格式和可读性会影响代码的可维护性和可扩展性,开发团队应统一代码格式,采用同一套简单的代码规则。

1.垂直格式:

  1.1).向报纸学习:源文件应像报纸一样,从上到下阅读,简洁明了。最顶部给出最高层次的概念和算法,向下依次展开,直到找到最底层的函数和细节;

  1.2).概念间垂直方向上的区隔:逻辑块之间可以加空行相互区隔开,让代码看起来更直观;

  1.3).垂直方向上的靠近:紧密相关的代码应当相互靠近;

  1.4).垂直距离:a.变量声明,变量声明应靠近其使用位置;b.实体变量:实体变量应在类的顶部声明;c.函数相关:存在调用关系的函数应放在一起,而且调用者应放在被调用者上面;d.概念相关:概念相关的代码放在一起,相关性越强,彼此距离应越短;

2.横向格式:

  2.1).水平方向上的间隔与靠近:用空格将彼此紧密相关的事物连在一起,也可用空格将相关性较弱的事物分开;函数名和左括号之间不加空格,因为函数与其参数紧密相关;函数的参数用逗号分隔开,表示参数是相互分离的;

  2.2).水平对齐:尽量对齐一组声明中的变量名或一组赋值语句的右值;

  2.3).缩进:源代码是一种继承结构,源代码在继承结构中位置都圈出一个范围,要让这种范围式继承结构可见,需要对继承结构中的代码块进行缩进;

  2.4).空范围:while、for等语句尽量不要使用空范围;

扫描二维码关注公众号,回复: 7603298 查看本文章

猜你喜欢

转载自blog.csdn.net/ldc9001/article/details/87096918