某日看代码对代码可读性的思考

缘起

今天去看编译模块的代码,发现实在是看不进去.究其原因,就是设计得有些混乱.这提醒了我,很多时候写代码的时候不会注意到一些设计上的问题.在阅读别人代码的时候会非常清晰地表现出来.其中有一些典型的问题.

命名之设计模式

比如使用了某种设计模式,但是命名却没有符合那个设计模式的规范.导致看了代码许久,才反应过来:"原来这里使用了××设计模式啊".

命名之方法内容

经常有些方法叫:"build××".但是其实里面的内容远多于build一个实体对象.而是包含了很多查询.从宏观上来说可以这么做,比较确实最后是build了一个Obj.但是在看代码的时候就容易忽视这个方法的实现.这么做其实很不好.

风格混搭

一会用Spring注入,一会用init方法,一会用构造方法.总之,一个初始化过程经常在使用不同的方式去构建.当然,这里恐怕不是某一个人的问题,如果项目参与的人数多了一些,就容易发生这种情况.

调用链路过长

这个问题特指由于功能本身的迭代.导致一些调用链路越来越长.而实际上有些类本身没有解决什么问题.