本文介绍如何更加轻松的阅读代码。

有人会说,阅读代码是否轻松,取决于代码的可读性吧。是的,而且请不要误会,本文不是要介绍编码规范。不管代码本身的可读性如何,你都可以找到更好的手段去帮助阅读。下面是几个可供参考的建议:

1、用丰富的颜色区分类型、成员、方法、变量、参数等等。例如下面两张图片,你觉得哪个阅读起来更轻松呢?

颜色的区分不仅仅是为了好看,颜色越多,代码展示的信息就越丰富。特别是当有时候变量名称覆盖了成员名称的时候,一眼就能看出来。

2、适当用空行将逻辑隔开。在下面的例子中,第一段的代码没有使用空行,看起来比较凌乱;第二段代码只是加了几个空行,逻辑马上变得清晰起来,有利于阅读。


3、为逻辑区块添加注释。有人说好的代码不需要注释,但一方面好的代码太少,另一方面英语不是我们母语,所以适当的加上注释是有必要的。

上面的代码没有加注释,虽然逻辑做了一定的整理,但要看懂还是不容易。

加了注释之后,看起来更轻松了。

另外,如果代码当中的变量命名晦涩,可以用重构的方式对变量重命名,以方便阅读。