想額外小小分享個人覺得重要的概念 『 假如寫了註解一定要維護 』
舉例
前幾年老闆委託寫尾牙發錢活動程式
中間改了幾次關於金錢的邏輯,特別獎金加碼,都沒有修改過註解
今年老闆又要舉辦一次尾牙抽獎,這次沒有加碼,另外把程式交給一個新進員工來修改。
```
void Main(){
/*
邏輯:
..略
- 當年資超過一年,獎金+2000
..略
*/
newYearBonusService.SetBonus(emloyee)
}
class NewYearBonusService{
public void SetBonus(Employee emloyee){
..略
if(GetJobTenure(emloyee)>=1) emloyee.Bonus += 8000;
..略
}
}
```
結果新人沒有去花時間去讀程式,直接相信你的註解,直接上線
抽獎當天才發現錢多給了6000,老闆大怒。
類似概念的例子在在現實偶而遇到,因為需求常變更,貪一時之便不去維護註解,
反而一開始就不要註解,把變數、方法命名取好,模組化做好,反而有更有幫助。
另外讀別人註解我個人的觀念(對版上很多前輩應該是基本概念):
『 註解只是補助,程式才是本體
註解會騙你,但程式碼不會騙你 』