iT邦幫忙

DAY 25
8

雞肋三十系列 第 25

[雞肋三十]25-職場心得之不如沒寫的程式註解

人人都知道,寫程式要寫註解。但是註解要寫得好,寫得不多也不少,寫得有意義,寫得讓人印象深刻,讓人會心一笑,就沒有那麼容易。這裡要談的,是最不想看到的程式註解。
海綿寶曾經奉指示維護一套藥品庫存管理系統,除了瓶瓶罐罐幾顆幾粒的最小單位之外,大致上跟一般進銷存系統差不多。

差不多是差不多,但是每個月底過帳盤點的時侯,數量總是會出問題,數量不是短缺就是多出來,由於差異並不太大,而使用者也不可能照實盤點,所以就睜隻眼閉隻眼,讓海綿寶將資料庫中的資料手動調整一下就算過了。

有一次轉檔過帳時程式出現錯誤而異常終止,海綿寶按著前人交接下來的文件,逐段逐行地Trace程式,最後來到了一個IF判斷式,而依據條件判斷,應該走到False這部份,此時,看到了一段寧願沒看到的程式註解:

//注意!如果程式跑到這裡,就真的掛了

看著前人的黑色幽默,只能苦笑了。

以上為真人真事,唯一與事實有「小小」差別的是,那個「前人」就是海綿寶,看到註解的是海綿寶的徒弟….Orz。

**結論:**寫程式要寫有意義的註解,過與不及都不好。

[雞肋三十]系列全文章列表


上一篇
[雞肋三十]24-專業想法之最誇張的專案意外
下一篇
[雞肋三十]26-職場心得之備份之黑色聖誕節
系列文
雞肋三十30
0
jamesjan
iT邦高手 1 級 ‧ 2009-10-28 08:13:35

還好沒有將藏寶圖寫在註解中...XD

0
總裁
iT邦好手 1 級 ‧ 2009-10-28 08:34:01

希望能跑出美味蟹堡.....肚子餓了.

0
魯大
iT邦高手 1 級 ‧ 2009-10-30 23:55:52

該不會連派大星都用上了..
那章魚哥呢??

恭喜魯大鐵人鍊成
心情很好哦....^_^

我要留言

立即登入留言