首頁 > web前端 > js教程 > 整潔的程式碼摘要

整潔的程式碼摘要

Mary-Kate Olsen
發布: 2024-12-06 03:53:10
原創
826 人瀏覽過

Clean Code Summary

如果程式碼可以被團隊中的每個人輕鬆理解,那麼程式碼就是乾淨的。乾淨的程式碼可以由原作者以外的開發人員閱讀和增強。可理解性帶來了可讀性、可更改性、可擴展性和可維護性。
一般規則

  • 遵循標準約定。
  • 保持簡單愚蠢。越簡單總是越好。盡可能降低複雜性。
  • 童子軍規則。讓露營地比您發現時更乾淨。
  • 總是找到根本原因。始終尋找問題的根本原因。

設計法則

  1. 將可設定資料保持在較高水準。
  2. 喜歡多態而不是 if/else 或 switch/case。
  3. 獨立的多執行緒程式碼。
  4. 防止過度配置。
  5. 使用依賴注入。
  6. 遵循德墨忒爾法則。一個類別應該只知道它的直接依賴關係。

可理解性提示

  1. 保持一致。如果你以某種方式做某件事,那麼所有類似的事情也以同樣的方式做。
  2. 使用解釋變數。
  3. 封裝邊界條件。邊界條件很難追蹤。將它們的處理放在一個地方。
  4. 優先選擇專用值物件而不是原始型別。
  5. 避免邏輯依賴。不要編寫依賴於同一個類別中其他內容而正確工作的方法。
  6. 避免否定條件。

命名法則

  1. 選擇描述性且明確的名稱。
  2. 進行有意義的區分。
  3. 使用可發音的名稱。
  4. 使用可搜尋的名稱。
  5. 用命名常數取代幻數。
  6. 避免編碼。不要附加前綴或類型資訊。

函數法則

  1. 小。
  2. 做一件事。
  3. 使用描述性名稱。
  4. 喜歡更少的爭論。
  5. 沒有副作用。
  6. 不要使用標誌參數。將方法拆分為幾個獨立的方法,這些方法可以在不帶標誌的情況下從客戶端呼叫。

評論規則

  1. 總是嘗試用程式碼來解釋自己。
  2. 不要多餘。
  3. 不要加入明顯的噪音。
  4. 不要使用右大括號註解。
  5. 不要註解掉程式碼。只需刪除即可。
  6. 用作意圖解釋。
  7. 用作代碼說明。
  8. 用作後果警告。

原始碼結構

  1. 垂直分隔概念。
  2. 相關代碼應垂直密集顯示。
  3. 宣告接近其用法的變數。
  4. 依賴函數應該關閉。
  5. 類似的功能應該很接近。
  6. 將函數放在向下的方向。
  7. 保持簡短。
  8. 不要使用水平對齊。
  9. 使用空格來關聯相關事物並分離弱相關事物。
  10. 不要破壞縮排。

物件與資料結構

  1. 隱藏內部結構。
  2. 更喜歡資料結構。
  3. 避免混合結構(一半物件和一半資料)。
  4. 應該很小。
  5. 做一件事。
  6. 少量實例變數。
  7. 基底類別應該對其衍生類別一無所知。
  8. 擁有許多函數比將一些程式碼傳遞到函數中來選擇行為更好。
  9. 優先選擇非靜態方法而不是靜態方法。

檢定

  1. 每個測驗一個斷言。
  2. 可讀。
  3. 快。
  4. 獨立。
  5. 可重複。

程式碼味道

  1. 剛性。軟體很難改變。一個小小的改變會引發一連串的後續改變。
  2. 脆弱。由於一次更改,該軟體在許多地方出現故障。
  3. 一動也不動。您無法在其他專案中重複使用部分程式碼,因為涉及風險和工作量。
  4. 不必要的複雜性。
  5. 無需重複。
  6. 不透明度。程式碼很難理解。

我想的就這麼多,但還有更多。
請閱讀整本書。

感謝您閱讀總結,希望對您有幫助。

網址:
https://kaleemelahi.co

買一杯咖啡給我:
https://buymeacoffee.com/kaleemelahi

以上是整潔的程式碼摘要的詳細內容。更多資訊請關注PHP中文網其他相關文章!

來源:dev.to
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板