如何写出好的代码(二)

时间:2021-01-06 00:00:57

1.  写注释更重要的是要描述为什么要写这 些,而不是这些是干什么的,因为这个应当尽量由代码自文档化。不过个人认为,当代码量很大的时候,毕竟代码是英文的,中文注释一下这一大段代码是干嘛的还 是可以让以后的人更容易找到并修改,不要太频繁太罗嗦就好,my poor English……T_T

2.  当你正在为你的某个程序不得不编写大 量的注释的时候,最好是停下来审视下,考虑一下是否可以更改代码或算法,让它变得更清晰一些。

3.  永远不要写模棱两可,含糊其辞的注 释,要尽可能具体。

4.  在改动代码的同时,记得检查是否有与 之相关的注释,不要不留心让它们成为“谎言”,所以永远相信代码而怀疑注释!

5.  一定要进行异常处理。

6.  除了要阅读技术书籍外,要匀出一部分 时间去学习和试用新的工具。(恩,我现在很需要做到这一点)

7.  测试代码应当与编写代码同步进行,这 样最易于修正,影响的人最少,造成的危害也最小。最好是在编写被测试的代码之前就编写好测试它的代码。

8.  在碰到一个程序故障时,在匆忙而轻率 地调试程序前,最少是停下来看看故障的特征,如是什么引发了这个故障,它是否可重复,频率如何,是否与同时进行的其他活动有关。

9.  不要对浮点型变量进行是否相等的运 算。

10.  当你认为你已找到一个bug的原因 时,彻底地研究它以证明你是正确的,不要盲目的接受你最初的假设。

11.  如果对于一个bug,你尝试了很多 方法都不管用,那么你可以尝试着对别人诉说整个问题,在这个过程中也许就会发现点什么……它可能是一直被你忽略的重要信息。

12. 在你遇到你无法解释的行为时,有节制的使用调试器。不要不停地使用调试器而不去理解你的代码是如何运行的。