Clean Code in JavaScript: Kaip rašyti švarų kodą?

JavaScript yra viena iš populiariausių programavimo kalbų pasaulyje, ir nieko keisto, nes ji naudojama tiek priekinėje, tiek užpakalinėje pusėje. Tačiau norint tapti tikru JavaScript meistru, reikia ne tik mokėti rašyti kodą, bet ir užtikrinti, kad jis būtų švarus, skaidrus ir lengvai prižiūrimas. Šiame straipsnyje aptarsime, kas yra švarus kodas JavaScript kalboje ir pateiksime keletą pavyzdžių, kurie padės jums rašyti efektyvų ir lengvai suprantamą kodą.

Kas yra švarus kodas?

Švarus kodas - tai kodas, kurį lengva skaityti, suprasti ir prižiūrėti. Tai ne tik kodas, kuris veikia, bet ir kodas, kuris yra suprantamas tiek jums, tiek jūsų kolegoms. Dauguma programuotojų praleidžia nemažai laiko, kuriant kodą, tačiau dažnai pamiršta apie jo kokybę. Švarus kodas užtikrina, kad ateityje, kai reikės atlikti pakeitimus ar pataisymus, viskas bus lengvai suprantama ir nereikės ilgo laiko praleisti bandant išsiaiškinti, kas kas yra.

Priežastys, kodėl svarbu rašyti švarų kodą

Rašyti švarų kodą labai svarbu, nes:

• Lengviau prižiūrėti: Kuo kodas švaresnis, tuo lengviau jį prižiūrėti ir atnaujinti. Tai ypač svarbu, kai dirbate komandoje.
• Mažiau klaidų: Kai kodas yra aiškus ir gerai struktūrizuotas, mažėja klaidų tikimybė, nes programuotojai gali lengviau suvokti logiką ir duomenų srautus.
• Geresnė bendradarbiavimo kokybė: Kiekvienas programuotojas turi žinoti, kaip lengvai susigaudyti kitų rašytame kode, kad būtų galima dirbti efektyviau.

Gerų praktikų laikymasis

Norint užtikrinti, kad jūsų JavaScript kodas būtų švarus, reikia laikytis tam tikrų gerų praktikų. Štai kelios esminės taisyklės:

1. Naudokite aiškius ir prasmingus pavadinimus

Viena svarbiausių švaraus kodo taisyklių yra aiškūs ir prasmingi pavadinimai. Pavadinimai turėtų tiksliai apibūdinti, ką kintamasis, funkcija ar klasė daro. Tai padės kitiems programuotojams greičiau suprasti jūsų kodą. Pavyzdžiui:

let x = 10; // Blogas pavadinimas

let userAge = 10; // Geras pavadinimas

2. Svarbu naudoti funkcijas ir metodus

Funkcijos yra vienas iš pagrindinių būdų, kaip organizuoti kodą ir padaryti jį lengviau suprantamą. Jei turite ilgas funkcijas su daugybe kodų eilučių, jas padalinkite į mažesnes, aiškias funkcijas, kurių kiekviena atliks vieną užduotį. Tai leis lengviau suprasti kodą ir palengvins vėlesnius pakeitimus.

function calculateDiscount(price) {
  return price * 0.10;
}

function showPriceWithDiscount(price) {
  let discount = calculateDiscount(price);
  console.log("Price after discount:", price - discount);
}

3. Komentarai, kurie paaiškina kodą

Kai kurie programavimo sprendimai gali būti sudėtingi, todėl kartais reikia paaiškinimų, kodėl buvo pasirinktas tam tikras metodas. Komentarai turėtų būti naudojami atsargiai – tik tada, kai kodas pats savaime nėra pakankamai aiškus. Nereikia komentuoti kiekvieno kodo žingsnio, tačiau kai kuriuos sudėtingus sprendimus verta paaiškinti.

// Pavyzdys: Komentuoti kodą, kai jis nėra visiškai aiškus
let discount = price * 0.10; // 10% nuolaida

Konkrečių pavyzdžių taikymas

1. Pavyzdys: Paprasta funkcija su blogu kodu

Pirmas pavyzdys parodys kodą, kuris nėra laikomas švariu. Čia turime funkciją, kuri apskaičiuoja kainą su nuolaida, tačiau ji yra labai blogai struktūrizuota ir sunkiai suprantama:

function calc(x) {
  let p = x * 0.10;
  let y = x - p;
  return y;
}

Šis kodas neveikia taip blogai, tačiau jis nesuteikia pakankamai informacijos apie tai, kas vyksta. Naudojami kintamieji, kurie nesuteikia jokios prasmės (pvz., "x" ir "y"). Geriau naudoti aiškesnius pavadinimus ir struktūrą.

2. Pavyzdys: Patobulinta versija

Šiame pavyzdyje naudojame aiškesnius pavadinimus ir geresnę funkcijų struktūrą:

function calculateDiscountedPrice(price) {
  const discount = price * 0.10;
  const finalPrice = price - discount;
  return finalPrice;
}

Ši versija yra aiškesnė, nes kiekvienas kintamasis turi aiškią reikšmę, o funkcija atlieka tik vieną užduotį – apskaičiuoja kainą su nuolaida.

Testavimas ir klaidų šalinimas

Testavimas yra neatsiejama švaraus kodo dalis. Nepakanka tik rašyti kodą, kad jis veiktų; svarbu ir įsitikinti, kad jis veikia teisingai. Reguliarus testavimas ir klaidų šalinimas užtikrina, kad jūsų kodas yra ne tik švarus, bet ir funkcionalus. Naudokite įrankius kaip Jest arba Mocha JavaScript testavimui, kad užtikrintumėte, jog jūsų funkcijos veikia teisingai ir nenaudojate klaidingų logikos sprendimų.

Apibendrinimas

Švarus kodas yra labai svarbus kuriant JavaScript programas, nes jis leidžia jums ir jūsų komandai lengviau prižiūrėti ir tobulinti projektą. Naudojant aiškius pavadinimus, funkcijas, kurios atlieka vieną užduotį, ir rašant suprantamus komentarus, galite užtikrinti, kad jūsų kodas bus švarus ir lengvai suprantamas. Niekada nepamirškite testuoti savo kodo ir nuolat jį tobulinti. Jei laikysitės šių praktikų, jūs tapsite ne tik efektyvesniu, bet ir geresniu programuotoju.