不积跬步无以至千里,不积小流无以成江海, 两千多年前,荀子就总结出这句至理名言,
每每阅及此类箴言,心中除了对先辈智慧的崇敬之外,更多是对自己的鞭策和激励。
我们做任何系统,不管简单还是复杂,最终落实下来,都是一行行的代码,要高质量的交付
一个系统,就应该从每一行良好的代码开始,写好每一个变量,写好每一个方法,写好
每一个类,写好每一个模块,构建好每个系统,实现由量到质的升华,如何写出良好的代码?
应该从以下方面入手。
一 勿以恶小而为之。
什么是恶小:
1 不规范的变量命名/方法命名/类命名
2 使用魔鬼数字
3 过多的if-else分支判断
4 不检查入参的有效性
5 强转对象前不检测类型
6 重复代码
7 不记录业务日志
8 不添加注释
这些小的不能再小的坏习惯,我们在编码中很容易低估它的危害,不以为意,殊不知这些‘恶小’,
会导致我们版本不稳定,不可维护,最重要一点,不规范的代码具有极强的感染力,一旦前人写了
不规范的代码,后继者就会自然而然的跟进,这种影响会随着系统的扩展、修改,越放越大。另一
方面,这些坏习惯会降低我们的代码审美力,提高我们对烂代码的容忍度。从而影响到整个系统。
二 勿以善小而不为。
什么是善小:
1 变量名/方法名/类名做到见名知意
2 关键逻辑添加注释
3 尽量使用语言自身的API
4 方法和类都添加doc注释
5 每个方法做到功能单一
这些不起眼的好习惯是最容易被忽略的,我们常常觉得要实现一个功能要用到xx设计模式,xx框架
才牛,觉得这些‘善小’无关紧要,其实不然,优秀的框架也是从这些小的好习惯开始的,任何事情都
有一个从刻意到随意的过程,牛人之所以能随意的写出好的代码,设计出好的框架,也是在于别人‘牛’
之前刻意去养成良好的习惯,道语有云:道生一,一生二,二生三,三生万物。我们编码也是如此,
如果你能写好一个变量,你就能写好一个方法,如果你能写好一个方法,你就能写好一个类,如果你
能写好一个类,你就能设计好一个模块,如果你能设计好一个模块,你就能驾驭好一个系统。
高质量交付---从每一行代码开始!