讓那些無用代碼注釋見鬼去

摘要——注釋簡單代碼會干擾對重要注釋的理解。程序開發者最好能用最精要的注釋來解釋重點代碼。

舉個例子，你打開一個電箱，里面有幾百根電線，蒙了吧。再一看，每根電線上面都有一個整潔的小標簽。真是謝天謝地啊!但是，當你一個個去翻看標簽的時候，見鬼的，幾乎所有的標簽都是空白的!

然后，在你花了整整一個小時去瀏覽每一個小標簽之后，終于給你找到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();

說說我的做法吧，當我考慮是否要寫注釋的時候，我就問自己：如果以后回過頭來看這些代碼，我能不能一下子明白當初為什么要這樣寫?如果以后我會非常感謝這些注釋，那么想也不用想，果斷寫上注釋。否則，就讓那些垃圾注釋見鬼去吧。