2008年5月9日 星期五

P02 所有修改都要為變動範圍註明原因

修改程式的原因如果不是為了重構就是為了除錯,無論如何都會有一個原因驅使我們去變動。在修改的同時,會希望把變動的原因以註解的方式記錄在程式碼裡,這樣就不會讓這次的改變在未來被淡忘。

註解除了記錄單次的改變之外,另一個目的是減少維護時的痛苦。對於後來接手程式的人來說,最好的狀況是只看現在版本的程式就能夠獲得所有版本的變動資訊,否則面對什麼註解都沒有的程式,勢必得拉出所有版本的內容才能明白哪裡有修改,基本上拿到一個版本號碼超過十的程式就不會有人再拉出來比對。

從這個角度來看可以明白程式裡適當的註解有多麼重要,可以讓所有人避免去比對多個檔案才能找出差異,而讓差異在同一份文件就看得出來,而且知道每一個差異發生的原因,這會是讓其他人迅速瞭解內部作法的捷徑。

沒有留言:

張貼留言