注释并不是纯然的好
“代码与注释”的关系,我诚然的多次听到这样的一种说法,“尽量每个函数,都写上详细的注释,这样以后别人接收就很容易理解。”其实,这样的说法存在弊端。
首先要明确一点,注释到底是干什么用的。注释的恰当用法是弥补我们用代码表达意图时遭遇的失败。换句话说,有意义的命名才是根本之道,如果我们无法准确的找到有意义的命名,那么注释可以增加代码的可理解性。注释不可以滥用,也不可以过度的依赖注释。其实,我一直认为,代码根本不需要注释,因为注释存在,是因为我们找不到对命名的良好表达方式。注释可以说是一个补救措施。
注释的有点是,增加可读性与可理解性。
注释的缺点是:可能因多个程序员的改动,造成注释内容陈旧,提供错误信息。
我一直不建议写注释的原因,是因为注释会说谎。一:就算是注释,汉语的表达也可能存在词不达意的情况。二:代码在变动,在迭代,在修改,不幸的是注释并不总是随之变动。我们不可忽略的一点是,注释存在的时间越久,就离其所描述的代码越远,也许是全然的错误。为什么我不建议写注释,很简单,随着人员的流动,项目的高速迭代,程序员能不能坚持长久的维护注释,谁也不能保证。
我们应该尽量做到,准确的命名,真正好的程序员是找到困难的解决方案,尽量不去写注释。
说了注释的很多缺点,其实注释本身没有错,错的是我们使用它的时机与地方。比如,警示的作用。如:“// 在此处共花费时间26小时”。这个就相当的有用,因为其他程序员看了,就知道,业务逻辑复杂,修改时候要细心,多琢磨一下。
什么也比不上良好的代码有用,什么也不会比乱起八糟的注释更有本事捣乱,什么也不会比陈旧,提供错误信息的注释更有破坏性。适当的时机,适当的位置使用注释,可以事半功倍。用错了,会浪费开发时间,影响项目进度。
注释并不是纯然的好。