建议编程时不要注释无用代码

    工作中,发现很多程序员习惯注释掉旧代码。我是不赞同这种做法的:我建议如果这些代码还有用,就将其提取出来,变成函数/类等会编译的单元,如果没用了就直接删除。不然日子久了,往往代码中充斥着大量旧代码注释。造成额外的维护负担:谁都不记得这些注释的作用了,又不知道能否直接删除。即使知道这些代码的作用,要用的时候反注释后可能也是一堆编译错误,未必比重写好多少。
    额外的负担其实还不是主要原因。其实更重要的是反映程序员是否慎重地对待每一行代码。我发现往往垃圾代码里都充斥着大量无用代码的注释。这些代码可能是网上撸来的,发现此路不通后又另外撸一段,或者注释掉里面几句重试。测试发现OK了就入库收工。这表现了一种不求甚解不求完美的编程风格和工作方式,这样是不利于编程水平提高的。
    删除一段代码的决定比注释一段代码要难下得多,这会逼着自己去思考是否要重构代码,将日后要用到的代码抽取出来。时间长了架构能力肯定会有所提高。
    即使删错了,还有svn的log呢,事情不是不可挽回。
    ps:在预研阶段,注释部分代码来run是正常的,不过测试完就应该把屁股擦干净。

你可能感兴趣的:(编程)