读《编写可读代码的艺术》
本文抽一些书中提到的、个人认为比较重要的原则或者方法,列举如下:
1、对方法和变量名选择专业的词,避免tmp(除非真的是暂时变量,比如交换两个数时作为中间变量)和retval(return value),用有意义的名字
2、用first, last表示闭区间[first, last];用begin, end表示左闭右开区间[begin, end);区分calcXXX和getXXX,calc意味着包含计算,而get通常是表示不包含计算,立刻得到
3、写注释,可以是描述函数行为,也可以是提醒注意的事项,如适用范围等等
4、简化控制流(if else, do while等等)
5、减少变量的引入,缩小变量作用域
6、抽取不相关的子问题,变为通用代码,有利于复用,也避免到处复制粘贴。
7、一次只做一件事(不要把一个方法写得太复杂,要拆分)
8、熟悉库函数
9、少写代码,砍掉不重要的需求。
10、关于测试,要使测试易于阅读和维护(不要过于冗长和复杂,要清晰)
……