程式碼整潔之道的一些總結
阿新 • • 發佈:2018-12-15
函式法則
- 函式體應該儘可能短小,每個函式只做一件事情
- 如果不是特殊要求,函式儘量使用少的引數;特殊情況除外,比如定義了一個笛卡爾座標系點的類,則設定的函式應該是
setData(int x, int y)
- 函式的語句應該在同一個抽象層級上,如果函式中抽象層級太多,會導致縮排語句太多,導致可讀性和擴充套件維護性差。正確的處理方式應該是把低層次的抽象封裝成一個函式
- 函式儘量使用異常來代替返回的錯誤碼,異常處理的
try
和catch
塊可以的話,單獨提取出來作為一個子函式使用,保證程式碼的可讀性。 - 避免重複。如果多個函式中都出現了相同的程式碼片段,或者一個程式碼片段在一個函式中出現了多次,那麼應該把這些程式碼塊封裝成一個函式。
- 如果一個函式呼叫了其他的子函式,那麼子函式在程式碼中的位置應該至於當前函式的下方。
類、物件和資料結構法則
- 類的作用是保證抽象性,因此封裝的資料不要直接暴露給呼叫者,而是封裝一系列的方法來保證抽象性
- 類的方法遵循Demeter定律,即類C的方法f只應該呼叫以下物件的方法:
- C
- 由f建立的物件
- 作為引數傳遞給f的物件
- C的實體變數持有的物件
- 類應該保證短小,一個類只保證一個實體的抽象或者只擁有一個權責
- 類應該保持內聚性,一個類中的資料和方法應該是為了保證實現某個權責或者是體現某個抽象而存在的