程式註解的功用

寫程式的人都知道「應該」要寫註解，在工作上也經常會被要求。可是問題是: 我已經算是比較勤奮的 programmer 了，即使偶而心血來潮會多寫一點，但是只要過了峰頭，很快回復原狀，總是有一搭沒一搭。想來想去，只能這樣解釋: 寫註解這件事應該是違反人性的，所以才要常常要求，時時提醒。

話說回來，懶得寫註解，在程式中註解符號 (在 C++ 中是 // 或是 /* */) 就用的少? 才不呢!

前一陣子突發奇想 (也是夠無聊了)，寫了一個小程式，算一算我自己的 code 用了多少註解符號。結果真是有趣: 有一個 550 行的 C++， /* */ 用了 384 對， // 用了 6132 個；平均下來，每個程式文字檔，大約有 1/3 到 1/4 的內容是在註解符號裡面。天啊! 我有這麼會寫註解嗎?

當然不是。只要寫過程式，都知道這些都是用來 mark 掉不想執行的程式碼。

年輕的時候沒想太多，現在做大叔了，得好好自我反省，我幹嘛這麼做而不是把它刪掉? 經過冷靜的分析，應該大約有這幾種心態:

• 我試試看這行沒有會怎樣，待會就會還原 (但 90% 的 case 之後就忘了)。

• 這部分要改寫，不過舊的 code 要參考，mark 起來先。

• 我好不容易寫的 code ㄟ，搞不好哪天要重用，捨不得刪掉

• 實在想不起來為什麼要 mark 掉，不過保險起見還是留著吧

我的心得是: 總有一天，我寫的程式，註解會比能執行的程式還多。