代码整洁之道 关于函数和注释方面的整理:
编程过程中函数应该尽可能满足以下几点:
1.短小:
每个函数控制在几行之内,并且一个函数只完成一件事,依次调转到下一个函数
2.单一职责:
函数应该只做一件事,做好这件事(判断是否只做一件事最简单的方法就是看该函数是否可在拆分)
3.一个函数的抽象层级
自顶向下读代码能读懂,向下规则
4.switch 语句
一般会显得冗长(解决:将switch语句埋藏在抽象工厂下)
5.使用描述性名称
6.函数参数最好保证在三个以下
不向函数传入boolean型的数据,否则要处理正确和错误的行为
如果函数需要三个以上的参数,把一些参数抽象为类
7.无副作用
不要其他影响功能的代码
8.使用异常代替返回错误代码
抽离try catch语句,把其他主体部分抽离成函数
9结构化编程
goto只有在小函数下才有道理,避免使用
关于注释:
注释不能美化烂代码,,,,花时间写注释不如重构
最好通过代码能表示出意义,即使没有注释也能看懂