只解释了“how”却没有解释“why”

入门级的编程课程通常会教育学生们写代码前先写注释、而且要尽量多注释。 这种教育的出发点是:

多注释肯定比少注释好、少注释肯定比没注释好。

例:

r = n/2;//让r等于n除以2

//当r-(n/r)大于t时进行循环

while (abs(r - (n / r)) > t)
{
    r = 0.5 * (r + (n / r));//设置r等于r+(n/r)的一半
}

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

的确,我也没明白。

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

//用牛顿-Raphson算法求n得平方根近似值

while (abs(r - (n / r)) > t)
{
    r = 0.5 * (r + (n / r));
}

这就好多了!==注释是用来帮助读者理解代码的,不是用来解释语法的。==

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值