代码中到底应不应当写注释?
当很多前辈教育后辈应当多写注释的时候,当网络上充满了有关程序员从不写注释的段子的时候,这是一个非常有争议的话题。作为一个标题党,容我先修正一下我的观点:我认为如果代码写得足够好,那么大多数注释是多余的,我们应该通过写出更好的代码来代替更多注释。
注释的确有其用途,但大部分情况下,程序员在滥用注释。我是反对夹杂在代码间的注释的,我认为注释应当从代码中独立出来——通常被称为文档。
请看下面一段代码。
/*/static/market/checkout.js
2014.7.2createbyorzfly 2014.7.29updatebyjysperm:fixbugs
TODO:这段代码中注释太多了,需要移除一些--jysperm */
varraw_products=req.query['products'].split(',');
//商品ID的数组 varproducts=[]
//过滤每个参数 for(vari=0,i<raw_products.length,i++){ if(!raw_products[i]) return;
//前端传来的数据中居然会有空格 if(!raw_products[i].trim()) return
/*2014.7.22:现在可以使用非数字ID了 //略过非数字条目 if(isNan(raw_products[i].trim().toFixed())) return; */
products.push(raw_products[i].trim().toFixed()); }
//总钱数 varsum=0;
//计算每个商品的总钱数 for(vari=0,i<products.length,i++){ //从数据库中查商品信息 vardata=db.product.byID(products[i]);
//TODO:谁来写一下没查到商品的情况
//把商品的价格加到总钱数上,a+=b是a=a+b的缩写 sum+=data.price; }