大到项目名、模块名、包名、对外暴露的接口,小到类名、函数名、变量名、参数名。
上一节课中我们讲了命名和注释,这一节课我们来讲一下代码风格(Code Style)。说起
代码风格,我们其实很难说哪种风格更好。最重要的,也是最需要我们做到的,是在团队、
项目中保持风格统一,让代码像同一个人写出来的,整齐划一。这样能减少阅读干扰,提高
代码的可读性。这才是我们在实际工作中想要实现的目标。
关于代码风格,我总结了 6 点我认为最值得关注的,今天跟你一块讨论学习一下。
1. 类、函数多大才合适?
总体上来讲,类或函数的代码行数不能太多,但也不能太少。类或函数的代码行数太多,一
个类上千行,一个函数几百行,逻辑过于繁杂,阅读代码的时候,很容易就会看了后面忘了
下载APP
前面。相反,类或函数的代码行数太少,在代码总量相同的情况下,被分割成的类和函数就
会相应增多,调用关系就会变得更复杂,阅读某个代码逻辑的时候,需要频繁地在 n 多类
或者 n 多函数之间跳来跳去,阅读体验也不好。
那一个类或函数有多少行代码才最合适呢?
我们在第 15 讲中提到过,要给出一个精确的量化值是很难的。当时我们还跟做饭做了类
比,对于“放盐少许”中的“少许”,即便是大厨也很难告诉你一个特别具体的量值。
对于函数代码行数的最大限制,网上有一种说法,那就是不要超过一个显示屏的垂