引言
代码格式决定读者对代码质量最初的判断。好的格式能够增强代码的可读性,并且能让读者阅读代码的时候心情愉悦。
格式的目的
代码格式关乎沟通。我们很多人在编写代码的时候更关注功能实现的正确性,往往认为功能正确就已经几近成功。可是在我们完成第一个版本后,我们写的这些代码极有可能会被修改,而代码格式与代码的可读性是成正比关系,代码风格会极大的影响到项目的可维护性和扩展性。
我们将从垂直格式和水平格式来谈谈如何可以更好的沟通。
垂直格式
源文件层次
源文件的名称应该简单、明了,其名称本身应该告诉我们是否在正确的模块中。源文件的顶部位置应该给出高层次的概念和算法,具体的实现细节应该在后面依次展开
概念间垂直方向上的间距
代码的阅读都是遵从自上而下、从左至右的的顺序。在代码中适当的插入些空白行可以极大的增强阅读代码时的视觉感受。比如:
每一空白行都暗示着一个线索,标识出新的独立概念。在阅读时很容易就会将目光停留在空白行之后的那一行,如果抽掉那些空白行,代码的可读性就会弱很多。
垂直距离
同一文件中函数调用,相互调用函数的应该在垂直方向上尽可能的靠近。在vscode中查看js代码时,如果调用双方距离较远时,经常会出现当我需要查看被调用方法时按ctrl+f去搜索,而当查看完后又要用ctrl+f搜索回来,极为耗时。因此,若某个函数调用了另外一个,就应该把他们放在一起,而且调用者应该放在被调用者上面,这样程序就有个自然的 顺序。如果能够坚持这条规则,那么读者就能知道函数声明很快就会在其调用后面出现,从而可以减少ctrl+f的次数。在非调用关系的函数之间也应该保证函数的顺序性。此外,概念相关的代码应该放在一起。相关性越强,彼此之间的距离就该越短。
横向格式
水平方向上的区隔与靠近
在编程的过程中,我们比较喜欢用空格符将一些紧密相关的事物连接到一起,有时候也用空格符把相关性较弱的事物分割开。 比如我们在赋值的时候通常会如:int a = 10这样将等号两边加上空格符以达到强调的作用,达到了分隔的效果。
水平对齐和缩进
如今一般IDE都会帮我们自动做这两件事儿,但是还是要强调同一层级的语句首字符要位于同一垂直线上。
结尾
在编写代码时要保证良好的代码格式,应该选用一套简单的管理代码格式的规则,并在整个项目中贯彻这一规则。整个团队也应该采用同一套规则,并且所有从成员都要遵从这一规则。
网友评论