想像一下，如果您試圖在凌亂的房間裡找到某樣東西，您會浪費時間尋找，對嗎？
對於混亂的程式碼也是如此！發現問題或了解正在發生的事情更加困難。使用乾淨的程式碼，您可以避免這種混亂。
編寫整潔程式碼的 7 個技巧🧯
1.使用有意義的名字
當您建立variable或function時，請為其指定一個能夠說明其用途的名稱。
可以想像為命名計算機上的資料夾。不要將其稱為b ，而是將其稱為numberOfUsers 。這樣，您就不需要額外的註解來解釋b是什麼。
例子：
let numberOfUsers = 5; // Clear and easy to understand2.遵循單一職責原則（SRP）
一個函數應該只做一項工作，並且把它做好。
這使得在需要時更容易理解和修復。這就像用一種工具完成一項任務，例如一支用於書寫的鉛筆和用於切割的剪刀。
例子：
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 user4. 讓你的程式碼可讀
使用空格、縮排和換行來保持程式碼整潔。
就像寫一個段落一樣，您應該將程式碼分成更小的部分，這樣它就不會全部在一行中。
例子：
// 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. 小心依賴關係
當你建立軟體時，盡量將各個部分分開，這樣它們就不會過度依賴彼此。
例如，洗碗機可以位於任何廚房，而不僅僅是一個特定的廚房。這樣管理起來比較容易。
7. 組織你的專案
讓您的文件和文件夾井井有條，就像保持辦公桌清潔一樣。當您的專案變得更大時，這可以讓您更輕鬆地找到東西。
例子：
-
在專案中使用諸如
components、services和utils之類的資料夾。 -
將相似的文件放在一起，以便您知道在哪裡可以找到它們。
✅ 推薦
使用此可列印後端開發人員概念範本來追蹤您的進度！ 🔥
初學者開發人員經常難以選擇正確的技術堆疊，這導致他們浪費時間並失去動力。
因此，我在Notion中建立了一個設計精美、非常容易遵循的6 個月後端開發人員路線圖，以便您可以追蹤您的進度並輕鬆堅持您的目標！
這個路線圖：
-
🛤️ 提供清晰的路徑以避免混亂。
-
🎯 概述從哪裡開始和結束，幫助您保持動力。
-
📚 遵循類似學校教學大綱的結構化計畫。
-
📅 透過工具和語言的每週目標來組織您的學習。
-
⏳ 確保在 6 個月內完成，涵蓋您所需的一切。
-
👀 有精美的設計，方便導航。
結論🏁
寫乾淨的程式碼就像為房子打下堅實的地基。它使一切井井有條，可以輕鬆加入新內容或修復問題，而不會遇到太多麻煩。
遵循以下 7 個技巧，讓您的程式碼變得簡單、可讀且易於使用！
了解更多： 6 個月內成為後端開發人員的技能（路線圖）
原文出處：https://dev.to/codewithshahan/how-to-write-clean-code-3599
1) --- 會變成分隔線（上一行必須是空白）
2) # 會變成一級標題
3) ## 會變成二級標題
4) ### 會變成三級標題
5) **粗體文字**會顯示粗體文字
6) ```當第一行與最後一行會顯示程式碼
7) 請搜尋 Markdown 語法，了解各種格式