9. 該如何寫出好的程式碼?如何滿足 KISS 原則?

2023年12月27日

💎 加入 E+ 成長計畫 與超過 350+ 位軟體工程師一同在社群中成長,並且獲得更多的軟體工程學習資源

程式碼先上:

def is_positive(number):
 if number > 0:
  result = True
 else:
  result = False
 return result

上面這段程式碼在說,如果數字為正數,則返回 True,反之則返回 False,這樣寫功能是正確的,但其實過於冗長,比較好的寫法如下:

def is_positive(number):
 return number > 0

下面的寫法滿足 KISS (Keep It Simple, Stupid) 原則,強調在設計和程式碼保持簡單,減少不必要的複雜性!

要寫出滿足 KISS 原則的程式碼,即保持簡單直接,可以遵循以下幾個關鍵指導原則:

  1. 明確和單一目的:每個函數或模組應該只有一個清晰定義的目的。避免創建多功能或過於複雜的函數。
  2. 直接表達:使用直接和簡單的語句來實現功能。避免不必要的間接或複雜的構造。
  3. 重用程式碼:利用現有的函數庫和框架,而不是重新發明輪子。這不僅可以減少程式碼量,還可以減少出錯的可能性。
  4. 避免過度抽象:雖然抽象化是一種強大的工具,但過度抽象可能會導致程式碼難以理解。適當地使用抽象化,但不要讓它變得過分複雜。
  5. 程式碼可讀性:寫出清晰易讀的程式碼,使用恰當的命名、注釋和格式化。易於閱讀的程式碼更容易維護和理解。
  6. 簡化邏輯:避免不必要的控制流程複雜性,比如過多的條件分支和迴圈嵌套。優先使用簡單的控制結構。
  7. 優化性能但不過度優化:在不損害程式碼清晰度的前提下優化性能。避免過早或過度優化,它們可能引入不必要的複雜性。
  8. 持續重構:定期重構程式碼以保持其簡潔和高效。隨著時間的推移,需求的變化可能會使原先簡單的解決方案變得不適用。
  9. 適當的錯誤處理:處理錯誤的方式應該簡單明了,不要引入不必要的複雜性。
🧵 如果你想收到最即時的內容更新,可以在 FacebookInstagram 上追蹤我們