2014年3月23日 星期日

Clean Code - Note

在程式中下註解是很常見的,

但在看完clean code後,

我開始思考註解的適當性及必要性,

有些書中提到的要點可以分享一下:

1.用code代替註解

書中有提到一個重要的觀念,

不要用註解拯救糟糕的code,

寧可重新改寫code,
 //to check the member's level is enough
 if(member.level <= office_premium && member.level > office_higher){
  
 }
 
 if(member.hasEnoughLevel()){
  
 }

第一個敘述看了註解之後,

或者你可以了解if中的判斷,

但採用第二種方式之後,

你便可以繼續往下閱讀並了解此段程式碼要做什麼事情。

2.不要留註解的程式碼

以前的code中很常看到這樣的方式,

有時候是為了測試,

有時候是流程或業務內容改變,

但也怕會忘記以前的寫法所以用註解的方式保存,

但現在都有版控的機制,

可以清楚記錄每次的改版,

所以,把註解的程式碼刪除,

避免久了造成不必要的誤會。

沒有留言:

張貼留言