首頁  >  文章  >  web前端  >  如何寫乾淨的程式碼

如何寫乾淨的程式碼

Mary-Kate Olsen
Mary-Kate Olsen原創
2024-10-23 16:39:02431瀏覽

為什麼要寫乾淨的程式碼? ⛩️

How to write clean code
想像一下,如果您試圖在凌亂的房間裡找到某樣東西,您會浪費時間尋找,對吧?

混亂程式碼也是如此!發現問題或了解正在發生的事情更加困難。使用乾淨的程式碼,您可以避免這種混亂。

你知道嗎? ..透過編寫乾淨的程式碼,您還可以節省其他開發人員寶貴的時間。相信我...你正在拯救世界! ?


寫出簡潔程式碼的 7 個技巧?

How to write clean code

1.使用有意義的名字

建立變數或函數時,為其指定一個名稱,以告訴它的作用

將其想像為命名電腦上的資料夾。不要稱之為 b,而是將其稱為 numberOfUsers。這樣,您就不需要額外的註解來解釋 b 是什麼。

範例

let numberOfUsers = 5; // Clear and easy to understand

2.遵循單一職責原則(SRP)

一個函數應該要做一項工作而且做得很好。

這使得在需要時更容易理解和修復。這就像擁有一種工具來完成一項任務,就像一支用於書寫的鉛筆和用於切割的剪刀。

How to write clean code

範例

function addNumbers(a, b) {
    return a + b;
}

此函數僅將兩個數字相加。它沒有做任何其他事情。

3. 避免不必要的評論

不要到處添加註釋,而是嘗試使用好名字讓你的程式碼不言自明

僅當某些事情棘手或需要特殊說明時才使用註釋。太多的評論會讓人們感到困惑。 ??

範例

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. 讓你的程式碼可讀

使用空格縮排換行符來保持程式碼整潔。

就像寫一個段落一樣,您應該將程式碼分成更小的部分,這樣它就不會全部在一行中。

範例

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. 編寫單元測試

單元測試是對程式碼的檢查。

他們確保一切正常運作。當您更改程式碼時,這些測試會告訴您是否有問題。

範例

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. 小心依賴關係

當你建立軟體時,盡量將各個部分分開,這樣它們就不會過度依賴彼此。

例如,洗碗機可以位於任何廚房,而不僅僅是一個特定的廚房。這樣管理起來比較容易。

How to write clean code

7. 組織你的項目

讓您的文件和文件夾井井有條,就像保持辦公桌清潔一樣。當您的項目變大時,這可以讓您更輕鬆地找到東西。

How to write clean code

範例

  • 在專案中使用元件、服務和實用程式等資料夾。
  • 將相似的文件放在一起,以便您知道在哪裡可以找到它們。

✅ 推薦

使用此可列印後端開發人員概念範本來追蹤您的進度! ?

初學者開發人員經常難以選擇正確的技術堆疊,這導致他們浪費時間並失去動力。

因此,我在 Notion 中創建了一個設計精美、非常易於遵循的 6 個月後端開發人員路線圖,以便您可以跟踪您的進度並輕鬆堅持您的目標!

How to write clean code

此路線圖:

  • ?️ 提供清晰的路徑以避免混亂。
  • ?概述從哪裡開始和結束,幫助您保持動力。
  • ?遵循類似學校教學大綱的結構化計畫。
  • ?透過工具和語言的每週目標來組織您的學習。
  • ⏳ 確保在 6 個月內完成,涵蓋您所需的一切。
  • ?具有精美的設計,方便導航。

How to write clean code


結論 ?

寫乾淨的程式碼就像為房子打下堅實的地基。它使一切井井有條,可以輕鬆添加新內容或修復問題,而不會遇到太多麻煩。

遵循這 7 個技巧,讓您的程式碼簡單、可讀且易於使用!

閱讀更多: 6 個月內成為後端開發人員的技能(路線圖)

以上是如何寫乾淨的程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn