还在写代码注释么?你Out了
还在写代码注释么?你Out了
如果把开发过程比作开车,那么代码的注释就相当于路边的指示牌。注释是辅助的信息,并不影响程序的最终执行结果。
一个好的代码注释会减少开发周期,比如帮助下一个接手的开发人员快速熟悉代码。
不好的代码注释则反过来影响了开发过程,因为可能会误人子弟,指错路。
所以,注释并不总是好事。
曾经有一个实验,就是随机抽取一个软件程序,在里面设置一些BUG,然后让一些小组去查找这些BUG,有趣的是50%的小组都会彻底删除软件中的注释。结果是,不使用注释的小组在更短的时间内发现了更多的BUG。
我们在代码中会碰到各种各样的注释。一些注释仅仅是开发人员即兴之作,一些表名了他们有多聪明!一些仅仅是一个玩笑。
例如:
//当我写这些的时候,只有上帝和我能懂//现在,仅仅上帝能懂了//我来为下列代码负责...//是他们强迫我写的,我不是自愿的//我要找一个更好的工作try {...}catch(SQLException ex) { //不用多说了,你很拧巴吧}catch(Exception ex2) { //如果你想你已经拧巴过,那么恭喜你,这次更加新鲜}