Zlepšete čitelnost a udržovatelnost kódu JavaScript dodržováním těchto konvencí pojmenování.

Aby bylo možné spravovat složité projekty JavaScriptu, je nezbytné zachovat jednoduchost, čitelnost a snadnou údržbu v kódu. Klíčem k dosažení tohoto cíle je důsledné dodržování konvencí pojmenování.

Proměnné, booleovské hodnoty, funkce, konstanty, třídy, komponenty, metody, soukromé funkce, globální proměnné a soubory patří mezi prvky JavaScriptu, které vyžadují konzistentní konvence pojmenování. Organizaci kódu a jeho porozumění můžete zlepšit implementací standardizovaných konvencí pojmenování ve všech těchto komponentách, což z dlouhodobého hlediska ušetří čas a úsilí.

1. Pojmenování proměnných

V JavaScriptu jsou data uložena v proměnných. Je nezbytné volit popisné názvy proměnných, které přesně odrážejí jejich funkci. Můžete například nahradit uživatelské jméno nebo Celková cena pro název proměnné spíše než X.

Dobrý způsob, jak pojmenovat proměnné, je následující:

nechat celková cena = 100;
nechat uživatelské jméno = "John";

Lepší čitelnosti kódu lze dosáhnout použitím popisných názvů proměnných

2. Pojmenování Boolean

Proměnné, které mohou mít pouze dvě hodnoty, tj skutečný nebo Nepravdivé, jsou známé jako Boolean. Je důležité zvolit vhodná jména pro booleovské proměnné, které vyjadřují jejich účel.

Pro ilustraci, místo volby názvu proměnné jako např je pravda, měli byste raději jít s je platná nebo hasValue.

Zvažte tento případ:

nechat isValid = skutečný;
nechat hasValue = Nepravdivé;

V tomto příkladu je z popisných booleovských názvů proměnných jasné, co představují.

3. Funkce pojmenování

Funkce v JavaScriptu odkazuje na samostatnou jednotku kódu, která je určena k provedení určitého úkolu. Je to blok kódu, který lze volat nebo vyvolat jinými částmi kódu a funguje jako nezávislá entita.

Pro efektivní pojmenování funkcí používejte popisné názvy, které vyjadřují jejich účel. Například místo toho vytvoření funkcefoo, zvolte ilustrativnější názvy jako validateUserInput nebo vypočítatCelkovou cenu.

Například:

funkcevypočítatCelkovou cenu(cena, množství) {
vrátit se cena * množství;
}
funkcevalidateUserInput(vstup) {
vrátit se vstup !== nedefinováno && vstup !== nula;
}

4. Pojmenování konstant

Konstanty jsou proměnné, které nelze znovu přiřadit. Při pojmenovávání konstant je důležité používat k oddělení slov všechna velká písmena a podtržítka.

Například:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;

V tomto příkladu byla k oddělení slov v názvech konstant použita všechna velká písmena a podtržítka.

5. Pojmenování tříd

V JavaScriptu lze objekty vytvářet pomocí plánů nazývaných třídy. Chcete-li dosáhnout neposkvrněných postupů pojmenování, je nanejvýš důležité spustit PascalCase, konvenci pojmenování, která vyžaduje psaní velkých písmen v prvním písmenu každého slova.

Vezměte si například:

třídaNákupní košík{
konstruktér(Udělat model) {
tento.make = dělat;
tento.model = model;
 }
}

V tomto příkladu třída Nákupní košík byla pojmenována pomocí PascalCase, což znamená, že první písmeno každého slova v názvu třídy bylo velké a mezi slovy nejsou žádné mezery ani podtržítka.

6. Pojmenování komponent

Komponenty jsou základními stavebními kameny v moderním vývoji softwaru, zejména v frameworky jako React, které kladou důraz na znovupoužitelný kód.

Rozdělením složitého uživatelského rozhraní nebo aplikace na menší, spravovatelné části můžete tvořit komponenty, které lze znovu použít v různých projektech, což zkracuje dobu vývoje a zvyšuje kód účinnost.

Opět velmi doporučujeme používat pro pojmenování komponent konvenci pojmenování PascalCase. To znamená velké první písmeno každého slova v názvu komponenty.

Taková konvence vám pomůže odlišit komponenty od jiných segmentů kódu, zjednoduší identifikaci a manipulaci.

funkceKnoflík(rekvizity) {
vrátit se<knoflík>{props.label}knoflík>;
}

V tomto příkladu byla pro pojmenování komponenty použita konvence pojmenování PascalCase Knoflík.

7. Metody pojmenování

Při pojmenovávání metod je důležité používat popisné názvy, které úspěšně sdělují, čeho metoda dosahuje, protože metody jsou funkce, které se vztahují k objektu.

Například:

třídaAuto{
konstruktér(Udělat model) {
tento.make = dělat;
tento.model = model;
 }
 startEngine() {
// kód pro spuštění motoru 
 } 
 stopEngine() { 
// kód pro zastavení motoru 
 }
 }
}

Popisná jména (startEngine, stopEngine) jsou použity pro metody v tomto příkladu, což zajišťuje, že jejich zamýšlený účel je snadno srozumitelný.

8. Pojmenování soukromých funkcí

Funkce definované jako soukromé jsou omezeny na přístup pouze v rámci objektu, kde jsou definovány. Je důležité přidat úvodní podtržítko (_), které označuje, že funkce jsou soukromé.

Zde je příklad:

třídaAuto{
konstruktér(Udělat model) {
tento.make = dělat;
tento.model = model;
 }
 _startEngine() {
// kód pro spuštění motoru
 }
 _stopEngine() {
// kód pro zastavení motoru
 }
}

Použitím úvodního podtržítka v tomto příkladu je indikováno, že funkce jsou soukromé.

9. Pojmenování globálních proměnných

K proměnným, které jsou klasifikovány jako globální, lze přistupovat z jakékoli části kódové základny. Při pojmenovávání takových globálních proměnných je zásadní používat jasné a popisné názvy, které efektivně vyjadřují jejich zamýšlený účel.

Například:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funkcezkontrolujte cenu(cena) {
-li (cena > MAX_PRICE) {
// kód pro zpracování vysokých cen
 } jiný-li (cena < MIN_PRICE) {
// kód pro zpracování nízkých cen
 }
}

10. Pojmenování souborů

Efektivní organizace souborů je zásadním aspektem úspěšného řízení projektů JavaScript. Chcete-li zajistit zjednodušené a konzistentní konvence pojmenování, je nezbytné oddělovat slova v názvech souborů pomocí malých písmen a pomlček.

Upřednostňují se malá písmena, protože JavaScript je jazyk citlivý na velká a malá písmena, což znamená, že jazyk zachází s malými a velkými písmeny odlišně. Použití malých písmen pro názvy souborů zajišťuje konzistenci a zabraňuje zmatkům při odkazování na soubory v kódu.

Pomlčky se používají k oddělení slov v názvech souborů, protože v názvech souborů nejsou povoleny mezery. Mohou být také použity jiné alternativy, jako jsou podtržítka nebo camelCase, ale pomlčky jsou obecně preferovány pro jejich čitelnost.

Použití pomlček také zpřístupňuje názvy souborů uživatelům s programy pro čtení z obrazovky nebo jinými pomocnými technologiemi.

moje aplikace/
├── src/
 ├── komponenty/
 ├── button.js
 ├── input-field.js
├── utils/
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

V tomto příkladu se k oddělení slov v názvech souborů používají malá písmena a pomlčky.

Význam dodržování konvencí pojmenování v JavaScriptu

Dodržování dobrých konvencí pojmenování je základním aspektem psaní čistého a udržovatelného kódu v JavaScriptu. Dodržováním těchto konvencí můžete učinit svůj kód čitelnějším a udržitelnějším, zejména v některých Frameworky JavaScriptu, kde musíte zpracovávat objemný kód, což vám může ušetřit čas a námahu dlouhý běh.