※ 引述《sec5566 (sec)》之銘言:
: 聽過說法是
: 1.寫註解是浪費時間,命名命的好不需要寫
講到這個我就想浮出來,
寫程式寫了也快20年了吧?
我真的不知道什麼叫做命名命的好不需要寫註解,
會覺得自己命名很棒而不需要寫註解,
是很自大的想法,
更多是用來偷懶當不想寫註解的理由,
實在搞不懂為什麼有人連花個5分鐘寫註解都不願意,
結果他放假,別人看不懂他的code,只能call他時,就要搞一小時,
程式100行以上就該寫,至少寫一下這個程式在幹什麼的,
如果是兩個人以上一起寫,也要寫一下那一部份是誰寫的
還有另一種狀況,
就是註解就變成用來內鬥的工具,
故意批對方註解寫得少,寫得看不懂要重寫,
然後硬凹說對方程式沒寫完,
結果自己註解寫得更少或更爛,
或是整個組識走向極端搞得每行都寫
註解沒有說一定要寫多少,
以自己,和同事能看得懂為準,
所以難理解的地方就要多寫,
同事功力不強的話,就要多寫,
(不是說越強的人越不用寫,因為要"互相配合",
而弱者要花更多時間了解你的code,
花一大堆時間教弱者,不如乾脆多寫註解來讓每個弱者來都能自己搞懂)
這種事和吃飯一樣,飯一定要吃,不吃會餓死,
要吃是以能吃到不餓為原則,
每個人餓的標準也不同,食量也不同,
但不用搞到吃到很撐,吃太撐也會死掉,
偏偏很多人就很極端
: 2.寫註解方便維護,而且讀中文一定比讀英文快
: 自己是常常忽略註解,
: 不過有空還是會補上,
: 因為程式都只有我在弄,
: 但是當大型系統過一陣子在拿出來改時,
: 就知道不寫註解真的是省小時間花大時間,
: 像是一堆函式傳幾個變數能跑出什麼,
: 還是同樣提資料,這2個提出來差在哪?
: 不寫後面維護的人,就要很辛苦去看裡面,
: 尤其是交接工作,
: 大家會寫註解嗎?
: