Jack的嵌入式Linux开发笔记——010——Keep simple, keep small

南楼画角 提交于 2019-12-28 23:42:32

        在代码设计中,应该尽量保持函数的短小和简单,避免一个函数做的事情太多,逻辑过于复杂。

        先说函数的长度。一个函数如果做的事情很多,代码就会很长,带来的问题就是不容易发现bug。试想一下,如果一个函数只有10行代码,那么如果其中包含错误的话,是很容易发现的。如果一个函数有几百行代码,要在里面找出错误会是一件很崩溃的事情。所以,应该尽量把函数的长度减小。如果一个函数做了5件事情,那么应该把它拆分成5个函数,每个函数分别完成一件事。这样不仅便于发现问题,也方便对函数进行命名。如果我们现在要为一个业务编写函数,该业务流程包含3个步骤,那么更好的方式是先分别写3个函数,每个函数对应于一个步骤,然后写一个总的函数,在该函数中调用那3个标识每个步骤的函数。而不是把所有的东西统统塞到一个函数里。

        再说函数内的逻辑。函数内的代码逻辑也要尽量简单。和短函数类似,逻辑简单的函数也更有利于发现错误。所以,如果一个函数的代码逻辑很复杂,就要考虑能否把它拆分成几个不同的函数,拆分后的每一个函数的代码逻辑是简单的。

        保持函数简单的另一个方面是尽量使用简单通用的语法,不要写“炫技”的语法。很多编程语言除了基础语法以外,还会提供很多技巧性语法,有些程序员就会喜欢使用这些技巧行的语法,看似很高明,其实对于整个项目来说,是弊大于利的。为什么这么说呢?首先这些技巧性的语法很可能是不通用的,可能到了语言的新版本就不支持了,或者换了一个应用场合就不支持了。就是它们的通用性不够好。其次也不便于理解。有些技巧的用法可能是比较生僻的,这样别人在读这段代码的时候可能会不认识这种语法,还要先去查,不便于理解。从另一个角度说,现在的软件系统都是很庞大很复杂的,如果还要求别人每次看到这种“炫技”的代码都要花时间去查找才能理解你的代码的意思的话,那么整体上的效率就会降低很多。所以请尽量使用通用的语法来实现功能,不要“炫技”!

        代码是给人看的,是给后面来维护这段代码的人看的。所以请尽量让代码写的简单,简单的代码更容易发现错误,无论是对于代码审查还是对调试时排查错误,简单的代码显然更有优势。

 

 

 

 

 

 

 

 

 

 

 

 

 

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!