1、注释
很多人都有过,在阅读别人代码的时候,都在抱怨为啥没有注释,或者所注释的内容跟代码所描述的不是同一件事,然后看的一头雾水的。那是因为注释很快会过时,而且所注释的内容没有谈及代码自身没有提到的动,要么就好好的编写注释,别闲扯,画蛇添足,时刻保持整洁。如果有被注释掉的代码,要及时删除。因为好的注释只应该描述有关代码和设计的技术性信息。
2、环境
构建系统应该是单步的小操作。可以用单个命令签出系统,并用单个指令构建它,以及可以运行全部单元测试。
3、函数
函数的参数数量应该少;而且尽量不用布尔值的参数,那样会容易让人产生迷惑;尽量删除那些不被调用过的函数;只做一件事。
4、重复
别重复自己。如果每次看到重复的代码时,就代表你遗漏了抽象。重复,就相当于你复制粘贴一样,可以用单一的方法来替代。
5、名称
名称,既简单又难。因为好的名称,能让人一眼就能明白作者想表达的是什么。例如:使用解释性变量、函数名称应该表达其行为、用命名常量替代魔术数等。
怎么样才能起好名称呢?
可以采用描述性名称、名称应与抽象层级相符、尽可能使用标准命名法、无歧义的名称、为较大作用范围选用较长名称、避免编码、名称应该说明副作用。
6、测试
很多人觉得,代码写出来,程序能正常运行就可以了,这是远远不够的,长期如此下去,等于自毁。要记住,测试驱动开发。
6.1、只要还有没被测试探测过的条件,或者还有没被验证过的计算,测试就还不够。
6.2、使用覆盖率工具,能又快又容易找到尚未检测过的if或catch语句。
6.3、别略过小测试,小测试容易编写,其文档价值高于编写成本。
6.4、被忽略的测试就是对不确定事物的疑问。使用哪种方式,取决于该不确定所涉及的代码是否要编译。