背景: 接上文。上文讲到注释,这里说格式。你是否经常很随意的把一个方法放到一个位置,把一个变量放到一个位置。随意的换行等等。
最好是一个团队,使用一套大家都认可代码格式规则,如果每个人随意一套规则,就会很乱!但是实现其他好像有点难。
代码格式很重要,因为代码风格关乎可读性和后期维护。
1、向报纸学习。
读报纸都是从上往下读的,读代码应该也是一样的。报纸的标题应该一目了然,代码的名称也应该一目了然,代码应该在顶部给出高层次的概念,细节应该紧随其后写在下面,往下展开。
2、概念间垂直方向上的区隔。
自上而下,每组代码行展示一个思路,思路之间空格隔开。比如:包生命、导入声明、变量声明、函数声明,都有空白隔开。
3、垂直方向上的靠近
紧密相连、相关的代码应该互相靠近。比如,看代码的时候,经常从一个函数方法跳到另一个函数方法,如果说这相关的函数就在下面,就不会因为跳来跳去跳糊涂了。所以,被调用的方法应该放在调用方法的下面。
变量声明:变量应该声明在它就近使用的地方。
概念相关的代码应该放在一起。相关性越强,彼此之间的间隔应该更短。
(我觉得,除此之外,大概念上也应该有位置的风格,比如,增、删、改应该放到代码的前面,因为这个改动小,代码量小,查询应该写在后面,因为查询的方式多、代码多、后期改动大,而且,单个查询应该放到列表查询后面,因为,列表查询可能会调用单个查询,符合垂直向上靠近的分隔。这样,当一个类的方法多的时候,你就能快速找到函数该在的位置)
4、横向距离。
一行代码应该不应该出现滚动条,但是由于每个人的字体大小不一样、屏幕大小不一样,所以,只能是一个大概!
5、团队规则
每个程序员都有自己喜欢的规则,但如果在一个团队中工作,应该团队说了算。
一组开发人员应该认同一种格式风格,每个成员都应该采用这种风格,一个软件不应该由一群对代码风格意见相左的人写的。