理解乾淨的程式碼：格式化⚡️

在軟體開發中，程式碼不僅是為機器服務的，也是為人類服務的。

正確的程式碼格式對於可讀性和可維護性至關重要。

《清潔代碼》第 5 章討論了這些原則，重點在於專業程式碼格式化的重要性。

---

？為什麼格式很重要

正確的格式不僅關乎美觀；還關乎美觀。這是關於清晰度的。格式正確的代碼：

• 提高可讀性：其他開發人員（或未來的你）可以快速掌握程式碼的功能。

• 增強可維護性：格式清晰的程式碼更容易更新、重構和除錯。

• 促進一致性：一致的程式碼是可預測的，減少任何閱讀它的人的認知負擔。

---

？程式碼格式化的關鍵原則

？ 1. 縱向開放：將相關程式碼分組在一起

垂直開放性是指使用空白行來分隔不同的程式碼區塊，以便更容易區分不同的部分。

範例：

function processOrder(order) {
    // Validate the order
    if (!validateOrder(order)) {
        throw new Error("Invalid order");
    }

    // Process payment
    const paymentResult = processPayment(order);

    // Update inventory
    updateInventory(order);

    // Notify customer
    notifyCustomer(order);
}

在此範例中，processOrder 函數中的每個步驟均由空行分隔，清楚地描繪了流程的不同階段。

---

？ 2. 橫向開放：調整程式碼以保持清晰

水平開放性涉及水平對齊程式碼以使其更具可讀性，特別是在處理類似或相關的語句時。

範例：

const productName  = "Laptop";
const productPrice = 999.99;
const productStock = 50;

以這種方式對齊變數宣告可以更容易地一目了然地看到每個變數代表的含義。

---

？ 3. 縮排：依層次結構建構程式碼

縮排是反映程式碼層次結構的關鍵。它可以幫助讀者快速識別屬於在一起的程式碼區塊，例如循環、條件和函數。

範例：

function calculateDiscount(price) {
    if (price > 100) {
        return price * 0.1;
    } else {
        return 0;
    }
}

這裡，if-else結構是縮排的，以表示傳回語句是條件邏輯的一部分。

---

？ 4. 線路長度：保持易於管理

長行程式碼可能難以閱讀和理解。一般規則是將行長度控制在 80-100 個字元以內。如果一行太長，請考慮將其分解。

範例：

// Instead of this:
const orderSummary = `Order for ${customer.name}, Total: $${order.total}, Items: ${order.items.length}`;

// Do this:
const orderSummary = `Order for ${customer.name}, 
    Total: $${order.total}, 
    Items: ${order.items.length}`;

將字串分成多行使其更具可讀性，特別是當字串包含多個變數時。

---

？ 5. 一致的支撐：減少混亂

支撐風格是一致性至關重要的另一個領域。兩種常見的樣式是：

• K&R 風格： 左大括號與語句在同一行。
• Allman 風格： 在新行上開啟大括號。

K&R 風格範例：

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

奧爾曼風格範例：

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

選擇一種風格並在整個程式碼庫中堅持使用它。一致性比具體風格更重要。

---

？ 6. 避免密集程式碼：留出喘息的空間

密集的程式碼，太多的操作被塞進一個很小的空間，可能很難閱讀。展開您的程式​​碼，使其更易於理解。

範例：

// Dense code
if (user.isLoggedIn) { user.showDashboard(); }

// Better
if (user.isLoggedIn) {
    user.showDashboard();
}

第二個版本更具可讀性，因為函數呼叫與條件位於單獨的行上。

---

---

結論✅

格式化對於程式碼的可讀性和可維護性很重要。

遵循乾淨程式碼中的原則，您可以讓您的 JavaScript 程式碼更專業、更易於理解和使用。

快樂編碼！

以上是理解乾淨的程式碼：格式化⚡️的詳細內容。更多資訊請關注PHP中文網其他相關文章！