代碼壞味道

一、重複代碼

重複代碼可能是最常見的代碼壞味道之一。重複代碼不僅影響可讀性,而且還會導致代碼變得臃腫和難以維護。在一些非常明顯的情況下,可以很容易地將重複代碼重構成一個函數或方法。重構代碼旨在將可重複的代碼轉移到單個位置,以減少可維護的代碼總量。

以下是一個重複代碼的例子:

if (x > 1) {
    m = "greater than one";
    // 重複代碼
    console.log(m);
} else {
    m = "less than or equal to one";
    // 重複代碼
    console.log(m);
}

可以重構為:

if (x > 1) {
    m = "greater than one";
} else {
    m = "less than or equal to one";
}
console.log(m);

二、過長的代碼行

過長的代碼行往往會導致代碼不易讀取,並且難以維護。過長的代碼行更容易出現錯誤,因為程序員可能會因為缺少足夠的上下文而遺漏某些代碼。一個好的規則是不要超過80個字符。如果一行代碼超過80個字符,可以嘗試將代碼拆分成多行。

以下是過長的代碼行的一個例子:

let someVariable = thisIsAVeryLongFunctionNameThatHasWayTooManyCharacters(x, y, z, a, b, c);

可以拆分成:

let someVariable = thisIsAVeryLongFunctionNameThatHasWayTooManyCharacters(
    x, y, z,
    a, b, c
);

三、魔數

在代碼中使用數字,稱為魔數。魔數在代碼中增加了不必要的複雜性,並且不利於代碼的維護。魔數的最佳解決方案是將它們轉換為有意義的常量或枚舉。這不僅使代碼更容易閱讀和理解,而且還避免了因某個數字改變而導致錯誤的代碼問題。

以下是一個魔數的例子:

if (score < 60) {
    console.log("你的成績是 D");
} else if (score < 70) {
    console.log("你的成績是 C");
} else if (score < 80) {
    console.log("你的成績是 B");
} else if (score < 90) {
    console.log("你的成績是 A");
} else {
    console.log("你的成績是 A+");
}

可以重構成:

const GRADE_D = 60;
const GRADE_C = 70;
const GRADE_B = 80;
const GRADE_A = 90;

if (score < GRADE_D) {
    console.log("你的成績是 D");
} else if (score < GRADE_C) {
    console.log("你的成績是 C");
} else if (score < GRADE_B) {
    console.log("你的成績是 B");
} else if (score < GRADE_A) {
    console.log("你的成績是 A");
} else {
    console.log("你的成績是 A+");
}

四、過長的函數

過長的函數不僅難以閱讀,還更難以測試和維護。一個長函數通常會執行太多任務,並且很難分離出單獨的功能。分解長函數的最佳方法是為每個任務創建單獨的函數。

以下是一個過長的函數的例子:

function calculateBill(price, quantity, tax, discount) {
    let totalPrice = price * quantity;
    totalPrice = totalPrice + totalPrice * tax;
    if (discount > 0) {
        totalPrice = totalPrice - discount;
    }
    return totalPrice;
}

可以拆分為:

function calculatePrice(price, quantity) {
    return price * quantity;
}

function calculateTax(amount, tax) {
    return amount + amount * tax;
}

function calculateDiscount(amount, discount) {
    return discount > 0 ? amount - discount : amount;
}

function calculateBill(price, quantity, tax, discount) {
    let totalPrice = calculatePrice(price, quantity);
    totalPrice = calculateTax(totalPrice, tax);
    totalPrice = calculateDiscount(totalPrice, discount);
    return totalPrice;
}

五、長參數列表

長參數列表不僅難以閱讀和維護,還可能會導致錯誤。最佳做法是盡量減少參數列表中的參數數量。如果可能,可以將多個參數組合在一起,創建一個單獨的對象來傳遞它們。

以下是一個長參數列表的例子:

function calculateBill(price, quantity, taxRate, discountRate, shippingMethod) {
    // ...
}

可以重構成:

function calculateBill(options) {
    const {
        price,
        quantity,
        taxRate,
        discountRate,
        shippingMethod
    } = options;
    // ...
}

calculateBill({
    price: 100,
    quantity: 2,
    taxRate: 0.15,
    discountRate: 0.2,
    shippingMethod: 'post'
});

原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-hant/n/238037.html

(0)
打賞 微信掃一掃 微信掃一掃 支付寶掃一掃 支付寶掃一掃
小藍的頭像小藍
上一篇 2024-12-12 12:09
下一篇 2024-12-12 12:09

相關推薦

  • Python周杰倫代碼用法介紹

    本文將從多個方面對Python周杰倫代碼進行詳細的闡述。 一、代碼介紹 from urllib.request import urlopen from bs4 import Bea…

    編程 2025-04-29
  • Python字符串寬度不限制怎麼打代碼

    本文將為大家詳細介紹Python字符串寬度不限制時如何打代碼的幾個方面。 一、保持代碼風格的統一 在Python字符串寬度不限制的情況下,我們可以寫出很長很長的一行代碼。但是,為了…

    編程 2025-04-29
  • Python基礎代碼用法介紹

    本文將從多個方面對Python基礎代碼進行解析和詳細闡述,力求讓讀者深刻理解Python基礎代碼。通過本文的學習,相信大家對Python的學習和應用會更加輕鬆和高效。 一、變量和數…

    編程 2025-04-29
  • 倉庫管理系統代碼設計Python

    這篇文章將詳細探討如何設計一個基於Python的倉庫管理系統。 一、基本需求 在着手設計之前,我們首先需要確定倉庫管理系統的基本需求。 我們可以將需求分為以下幾個方面: 1、庫存管…

    編程 2025-04-29
  • Python滿天星代碼:讓編程變得更加簡單

    本文將從多個方面詳細闡述Python滿天星代碼,為大家介紹它的優點以及如何在編程中使用。無論是剛剛接觸編程還是資深程序員,都能從中獲得一定的收穫。 一、簡介 Python滿天星代碼…

    編程 2025-04-29
  • 寫代碼新手教程

    本文將從語言選擇、學習方法、編碼規範以及常見問題解答等多個方面,為編程新手提供實用、簡明的教程。 一、語言選擇 作為編程新手,選擇一門編程語言是很關鍵的一步。以下是幾個有代表性的編…

    編程 2025-04-29
  • Python實現簡易心形代碼

    在這個文章中,我們將會介紹如何用Python語言編寫一個非常簡單的代碼來生成一個心形圖案。我們將會從安裝Python開始介紹,逐步深入了解如何實現這一任務。 一、安裝Python …

    編程 2025-04-29
  • 怎麼寫不影響Python運行的長段代碼

    在Python編程的過程中,我們不可避免地需要編寫一些長段代碼,包括函數、類、複雜的控制語句等等。在編寫這些代碼時,我們需要考慮代碼可讀性、易用性以及對Python運行性能的影響。…

    編程 2025-04-29
  • 北化教務管理系統介紹及開發代碼示例

    本文將從多個方面對北化教務管理系統進行介紹及開發代碼示例,幫助開發者更好地理解和應用該系統。 一、項目介紹 北化教務管理系統是一款針對高校學生和教職工的綜合信息管理系統。系統實現的…

    編程 2025-04-29
  • Python愛心代碼動態

    本文將從多個方面詳細闡述Python愛心代碼動態,包括實現基本原理、應用場景、代碼示例等。 一、實現基本原理 Python愛心代碼動態使用turtle模塊實現。在繪製一個心形的基礎…

    編程 2025-04-29

發表回復

登錄後才能評論