以下列出一些自己在學習過程中,好的老師曾經提醒過的重點:
- 在 eclipse 畫面中,盡量把 method 行數限至在 50 行以內,能夠一個畫面就看完這整個 method 在做什麼,太長的 method 盡量將其整理分開成更小的單元,盡量讓一個 method 只專注在一件事,例如它是控制流程、或是處理資料細節等。
- 針對每個 public method 寫下簡潔易懂的註解說明,這對於維護的人跟使用的人都相當重要。
- 善用 checkStyle、findBugs 、codeCoverage 這些幫助讓 code 更好的工具,不符合就修到好,盡量修到好,愛用 ctl+shift+f 排版,愛用 ctl+shift+o 整理 import。
- 良好的變數命名習慣,寧願使用較長的變數名稱也不要使用短到讓人不知道是在做什麼的變數名稱,目前我們的習慣是用 lower camel case。
- 在 class 中,若 method 沒用到 member,可以將 method 標成 static。變數可以的話也標記 final。
- log 分層原則,記錄 vo 值的盡量記成 trace ,重要的才記成 info 或 debug,以免現場記錄太多不必要的資訊。
- Synchronized 因為即使使用單元測試也很難測,所以要記錄 log 以便在實際環境執行時觀察在 multi threads 下是否有正確運作。讀 cache 或清 cache 也盡量記一行有被呼叫到的 log。
沒有留言:
張貼留言