摘要——注释简略代码会搅扰对重要注释的了解。程序开发者最好能用最精要的注释来解说要点代码。
举个比如，你翻开一个电箱，里边有几百根电线，蒙了吧。再一看，每根电线上面都有一个整齐的小标签。真是谢天谢地啊!可是，当你一个个去翻看标签的时分，见鬼的，几乎一切的标签都是空白的!
然后，在你花了整整一个小时去阅读每一个小标签之后，总算给你找到12条有用的信息，诚心喜大普奔!当然，期望在你脑筋一片紊乱的时分得出的成果仍然是正确的，没有遗失，呵呵呵。
当我需求研讨代码的时分看到处处都是废物注释，唉，我的感觉就和上面在那么多标签里边找有用的相同。见鬼的，想从一大堆废物注释里确认哪个有用几乎就像难如登天!
说一个常用的开源项目，里边都是这些废物注释：
/**
* __construct function.
*
* @access public
* @return void
*/
public function __construct() {
…
}
再来一个：
/**
* Constructor
*/
public function __construct() {
…
}
还有一个
// Convert float to string
$value = float_to_string( $value );
这些注释就跟电箱里的空白标签相同，明晃晃的摆在那里，添加搅扰还下降注释的可用性。看到这样的注释，怪不得那些不幸的开发人员要夜以继日了。
我敢肯定，那个把空白标签贴在每根电线上的电工自以为这是一个特棒的主见，他协助了那些在他后边来的人：他们有什么想写的，只需在这些现已贴好的标签上面写就能够了。当然也有或许他原本计划自己填好一切标签。放下他的善意不说，这样做的成果诚心是糟透了，还不如只贴那有用的12张呢!
在编程的时分，开发人员常常被奉告要注释，可是他们中很少有人知道怎样注释才好。所以开发人员注释代码的时分，并不是由于有必要，而是由于他们觉得这是责任。开发人员以为假如在代码中多多注释，能体现他们工作能力。
见鬼的，这也不知道是哪门子的理论。我最厌烦每隔几行代码就有注释，而实际上却屁用没有。注释的效果绝对不是为了朴实夸耀咱们是“不明觉厉”的程序员，而是为了要点记载咱们搞这些代码的原因。这样一来，那些废物注释就能滚蛋了。看下面的比如:
// We need to account for product price changes,
// so we get the price of the product when each order occurred
$order_prices = $this->get_order_prices();
说说我的做法吧，当我考虑是否要写注释的时分，我就问自己：假如今后回过头来看这些代码，我能不能一会儿理解最初为什么要这样写?假如今后我会非常感谢这些注释，那么想也不必想，决断写上注释。不然，就让那些废物注释见鬼去吧。
