1. 程式人生 > >《Clean Code之道》(二)註釋、程式碼格式

《Clean Code之道》(二)註釋、程式碼格式

註釋:     1、儘量用程式碼來闡述
    //check to see if the empoyee is eligible for full benefits
    if((employee.flags & HOURLY_FLAG) && (employee.age > 65))
    還是這個
    if(employee.isEligibleForFullBeenefits())    
    2、保留警告性的註釋     3、日誌式、重複性、冗餘的、誤導性的註釋刪掉
    //the day of  the month
    private int dayOfMonth
    如果一個變數(或者方法名)還需要註釋來說明,那麼這個變數(或者方法名)的命名肯定不是最合適的,不應該是添加註釋,而是重新命名。當然,必要的演算法思想解釋型註釋除外。     4、註釋應該是言簡意賅,如果註釋本身還需要解釋,那可以刪掉了。