代码本身可以说明问题的确是很棒的,但并不是说注释不重要,有时候我更喜欢先看注释,因为它总比我看代码更快的了解这程序是做什么的—— 引用自《编程思想:我现在是这样编程的》 入门级的编程课程通常会教育学生们写代码前先写注释、而且要尽量多注释。

    这种教育的出发点是:多注释肯定比少注释好、少注释肯定比没注释好。

    要想写出好的注释,你必须是位优秀的作家 — from 高效能程序员的修炼

    例:

    1. r = n/2;//让r等于n除以2
    2. //当r-(n/r)大于t时进行循环
    3. while (abs(r - (n / r)) > t)
    4. {
    5. r = 0.5 * (r + (n / r));//设置r等于r+(n/r)的一半
    6. }

    经过这样的注释,你否明白了这段代码是干什么的?的确,我也没明白。

    问题就在于:虽然有大量的注释,可它们只是描述了代码是干什么的,却没有说明代码为什么要这样写。

    1. //用牛顿-Raphson算法求n得平方根近似值
    2. while (abs(r - (n / r)) > t)
    3. {
    4. r = 0.5 * (r + (n / r));
    5. }

    这就好多了!注释是用来帮助读者理解代码的,不是用来解释语法的,注释应该用于表述程序为什么这样工作。
    业务复杂的商业代码、工程化代码,最好还是通过注释来说明业务逻辑