原則: 寫整潔的代碼.
每當有機會去修改或增加功能的時候, 實際都可以對該部分代碼進行繼續優化或重構.
下面介紹 7 個原則:
- 讓代碼在代碼單元層面上符合可維護性要求
- 讓代碼自解釋
- 清理掉注釋了的代碼
- 清理掉無用代碼(Dead Code)
- 清理長的標識符
- 清理魔法常數
- 清理差勁的錯誤處理
第一點要求代碼在代碼單元層面上保持可維護, 即需要保證:
- 寫短小的代碼單元(15行內)
- 寫簡單的代碼單元(環路復雜度在5以內)
- 寫擁有簡單接口的代碼單元(參數個數不超過4個)
- 清理重復代碼(可檢測的只有復制粘貼型重復, 邏輯重復需要人工檢查)
遇到代碼中有不符合要求的情況時, 需要對代碼進行重構.
一般來說, 在代碼中出現的單行注釋都是不好的代碼的預兆. 因為這有可能表示在一個代碼單元中做了多件事情. 而最好的代碼是自解釋的, 即這行代碼在這個代碼單元中, 這行代碼整體上就可以被解釋, 然后一個代碼單元自己又可以自解釋, 這樣在任意調用位置都能夠保證代碼中不存在內部注釋.
無用的代碼指的是那些不再被調用的代碼, 或者是調用了, 但其結果不再被使用到的代碼. 另外還有如下三種類型的無用代碼:
- 方法中永遠無法被執行到的代碼
- 無用的私有方法
- 在注釋中的演示代碼
對于標識符而言, 避免長標識符, 一般的做法是在團隊內部形成一套正式的標識符命名規范, 或者是一套非正式的, 能夠保證穩定實施的, 根據業務領域確定的命名規則.
但標識符的命名絕非易事, 有時可能要經過幾次迭代, 才能確定這個方法的正確命名.
不過總的原則是, 應避免使用長標識符. 但具體多長的限制則應根據具體情況確定.
當遇到魔法數字的時候, 應將其替換為常量進行處理.
