Vždy používejte stejné konvence kódování pro všechny své JavaScripty projekty.
Kódovací konvence jsou stylové pokyny pro programování. Obvykle pokrývají:
Pravidla pojmenování a deklarace proměnných a funkcí.
Pravidla pro použití mezer, odsazení a komentářů.
Praktiky a principy programování.
Konvence kódování zabezpečená kvalita:
Zlepšete čitelnost kódu
Usnadněte si údržbu kódu
Konvence kódování mohou být zdokumentovaná pravidla, kterými se týmy mají řídit, nebo mohou být pouze vaší individuální praxí kódování.
Tato stránka popisuje obecné konvence kódu JavaScript používané W3Schools.
Měli byste si také přečíst další kapitolu „Best Practices“ a naučit se, jak se vyhnout nástrahám kódování.
Ve W3schools používáme pro názvy identifikátorů (proměnných a funkcí) camelCase.
Všechny názvy začínají písmenem.
Ve spodní části této stránky najdete širší diskusi o pojmenovávání pravidla.
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);Vždy dávejte mezery kolem operátorů (=+ - */) a za čárky:
let x = y + z;
const myArray = ["Volvo", "Saab",
"Fiat"];Pro odsazení bloků kódu vždy používejte 2 mezery:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}K odsazení nepoužívejte tabulátory (tabulátory). Různé editory interpretují karty odlišně.
Obecná pravidla pro jednoduchá tvrzení:
Jednoduché tvrzení vždy zakončete středníkem.
const cars = ["Volvo", "Saab",
"Fiat"];
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};Obecná pravidla pro složité (složené) příkazy:
Umístěte otevírací držák na konec prvního řádku.
Použijte jedno místo před otevírací konzolou.
Umístěte uzavírací závorku na nový řádek bez úvodních mezer.
Složité tvrzení neukončujte středníkem.
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}for (let i = 0; i < 5; i++) {
x += i;
}if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}Obecná pravidla pro definice objektů:
Umístěte otevírací závorku na stejný řádek jako název objektu.
Mezi každou vlastností a její hodnotou použijte dvojtečku plus jednu mezeru.
Používejte uvozovky kolem řetězcových hodnot, nikoli kolem číselných hodnot.
Nepřidávejte čárku za poslední pár vlastnost-hodnota.
Umístěte uzavírací konzolu na nový řádek, bez vedoucí prostory.
Definici objektu vždy ukončete středníkem.
Krátké objekty lze psát komprimované, na jeden řádek, pouze pomocí mezer mezi vlastnostmi, jako je toto:
Kvůli čitelnosti se vyhněte řádkům delším než 80 postavy.
Pokud se příkaz JavaScript nevejde na jeden řádek, nejlepší místo pro přerušení je za operátorem nebo čárkou.
document.getElementById("demo").innerHTML =
"Hello Dolly.";Zkuste to sami →
<!DOCTYPE html>
<html>
<body>
<h2>My Web Page</h2>
<p>The best place to break a code line is after an operator or a comma.</p>
<p id="demo"></p>
<script>
document.getElementById("demo").innerHTML =
"Hello Dolly.";
</script>
</body>
</html>
Vždy používejte stejnou konvenci pojmenování pro veškerý svůj kód. Například:
Názvy proměnných a funkcí zapsané jako camelCase
Globální proměnné psané VELKÝMI PÍSMENY (My ne, ale je docela běžné)
Konstanty (jako PI) psané VELKÝMI PÍSMENY
Pokud používáte hyp-hens, camelCase, popř podtržítka v názvech proměnných?
To je otázka, kterou programátoři často řeší. Odpověď závisí na tom, kdo jste dotázat se:
Pomlčky v HTML a CSS:
Atributy HTML5 mohou začínat daty (data-quantity, data-price).
CSS používá pomlčky v názvech vlastností (velikost písma).
Spojovníky lze zaměnit za pokusy o odčítání. V názvech JavaScriptu nejsou povoleny spojovníky.
Podtržítka:
Mnoho programátorů dává přednost použití podtržítek (datum_narození), zejména v SQL databází.
V dokumentaci PHP se často používají podtržítka.
PascalCase:
PascalCase je často preferován programátory C.
camelCase:
camelCase používá samotný JavaScript, jQuery a další JavaScript knihovny.
Nezačínejte jména znakem $. Dostanete se do konfliktu s mnoha názvy knihoven JavaScriptu.
Pro načítání externích skriptů použijte jednoduchou syntaxi (atribut type není nutné):
<script src="myscript.js"></script>Důsledek používání "neuspořádaných" stylů HTML může vést k chybám JavaScriptu.
Tyto dva příkazy JavaScriptu poskytnou různé výsledky:
const obj = getElementById("Demo")
const obj = getElementById("demo")Pokud je to možné, použijte v HTML stejnou konvenci pojmenování (jako JavaScript).
Navštivte Průvodce styly HTML.
Soubory HTML by měly mít příponu .html (.htm je povoleno). <p>Soubory CSS by měly mít příponu .css.
Soubory JavaScript by měly mít příponu .js.
Většina webových serverů (Apache, Unix) rozlišuje velká a malá písmena v názvech souborů:
london.jpg není přístupný jako London.jpg.
Jiné webové servery (Microsoft, IIS) nerozlišují malá a velká písmena:
london.jpg je přístupný jako London.jpg nebo london.jpg.
Pokud používáte kombinaci velkých a malých písmen, musíte být extrémně konzistentní.
Pokud přejdete ze serveru, který nerozlišuje malá a velká písmena, na server citlivý na velká a malá písmena, dokonce i malý chyby mohou poškodit váš web.
Chcete-li se těmto problémům vyhnout, vždy používejte názvy souborů s malými písmeny (pokud je to možné).
Počítače nepoužívají konvence kódování. Většina pravidel má malý dopad na provádění programů.
Odsazení a mezery navíc nejsou v malých skriptech významné.
U kódu ve vývoji by měla být preferována čitelnost. Větší produkce skripty by měly být minimalizovány.