如果程式碼可以被團隊中的每個人輕鬆理解,那麼程式碼就是乾淨的。乾淨的程式碼可以由原作者以外的開發人員閱讀和增強。可理解性帶來了可讀性、可更改性、可擴展性和可維護性。
一般規則
- 遵循標準約定。
- 保持簡單愚蠢。越簡單總是越好。盡可能降低複雜性。
- 童子軍規則。讓露營地比您發現時更乾淨。
- 總是找到根本原因。始終尋找問題的根本原因。
設計法則
- 將可設定資料保持在較高水準。
- 喜歡多態而不是 if/else 或 switch/case。
- 獨立的多執行緒程式碼。
- 防止過度配置。
- 使用依賴注入。
- 遵循德墨忒爾法則。一個類別應該只知道它的直接依賴關係。
可理解性提示
- 保持一致。如果你以某種方式做某件事,那麼所有類似的事情也以同樣的方式做。
- 使用解釋變數。
- 封裝邊界條件。邊界條件很難追蹤。將它們的處理放在一個地方。
- 優先選擇專用值物件而不是原始型別。
- 避免邏輯依賴。不要編寫依賴於同一個類別中其他內容而正確工作的方法。
- 避免否定條件。
命名法則
- 選擇描述性且明確的名稱。
- 進行有意義的區分。
- 使用可發音的名稱。
- 使用可搜尋的名稱。
- 用命名常數取代幻數。
- 避免編碼。不要附加前綴或類型資訊。
函數法則
- 小。
- 做一件事。
- 使用描述性名稱。
- 喜歡更少的爭論。
- 沒有副作用。
- 不要使用標誌參數。將方法拆分為幾個獨立的方法,這些方法可以在不帶標誌的情況下從客戶端呼叫。
評論規則
- 總是嘗試用程式碼來解釋自己。
- 不要多餘。
- 不要加入明顯的噪音。
- 不要使用右大括號註解。
- 不要註解掉程式碼。只需刪除即可。
- 用作意圖解釋。
- 用作代碼說明。
- 用作後果警告。
原始碼結構
- 垂直分隔概念。
- 相關代碼應垂直密集顯示。
- 宣告接近其用法的變數。
- 依賴函數應該關閉。
- 類似的功能應該很接近。
- 將函數放在向下的方向。
- 保持簡短。
- 不要使用水平對齊。
- 使用空格來關聯相關事物並分離弱相關事物。
- 不要破壞縮排。
物件與資料結構
- 隱藏內部結構。
- 更喜歡資料結構。
- 避免混合結構(一半物件和一半資料)。
- 應該很小。
- 做一件事。
- 少量實例變數。
- 基底類別應該對其衍生類別一無所知。
- 擁有許多函數比將一些程式碼傳遞到函數中來選擇行為更好。
- 優先選擇非靜態方法而不是靜態方法。
檢定
- 每個測驗一個斷言。
- 可讀。
- 快。
- 獨立。
- 可重複。
程式碼味道
- 剛性。軟體很難改變。一個小小的改變會引發一連串的後續改變。
- 脆弱。由於一次更改,該軟體在許多地方出現故障。
- 一動也不動。您無法在其他專案中重複使用部分程式碼,因為涉及風險和工作量。
- 不必要的複雜性。
- 無需重複。
- 不透明度。程式碼很難理解。
我想的就這麼多,但還有更多。
請閱讀整本書。
感謝您閱讀總結,希望對您有幫助。
網址:
https://kaleemelahi.co
買一杯咖啡給我:
https://buymeacoffee.com/kaleemelahi
以上是整潔的程式碼摘要的詳細內容。更多資訊請關注PHP中文網其他相關文章!