- 避免魔鬼数字:
- 将数字通过宏定义或者枚举赋予有意义人类可读的字符串名;
0. 可读性
- 代码可读性,最基本的是变量名、函数名、类名的可读性,其次是语句本身的可读性,最后是代码段逻辑的可读性;
- 反面案例是,有时候我们为了搞懂一个函数,甚至一个变量的含义,要把整个代码段完整地读下来,效率极低;
- 可读性,是尽可能低地降低入门和上手成本;
- 好的变量名,本身即是一种注释,
- 尽量多的使用关键字参数(如果语法支持的话)的形式,在函数声明处以及调用处即可获悉各个参数的含义;
1. 代码文件的拆分
- 将所有的源代码都写在一个文件中,最开始还很清楚,及至到后来,功能不断扩展添加,一个程序源代码的文件可以长达数百万行,那么该代码无论是维护,还是功能添加,还是调试和定位,都是一种灾难;
- 同一个源代码文件的文件拆分;
- 通过置于不同的包进行拆分;
- 业务型代码,逻辑性代码,工具性代码拆分;
- 模块化和层次化:
- 不同模块之间相互依赖(通信)又相互独立
2. 日志
- 关键操作,成功或失败一定要给出必要的日志信息,方便在不进行单步调试代码的前提快速定位;