Mindig ugyanazt a kódolási konvenciót használja az összes JavaScripthez projektek.
A kódolási konvenciók stílusi irányelvek a programozáshoz. Általában a következőkre terjednek ki:
Változók és függvények elnevezési és deklarációs szabályai.
A szóköz, a behúzás és a megjegyzések használatának szabályai.
Programozási gyakorlatok és alapelvek.
A kódolási konvenciók biztosítják a minőséget:
A kód olvashatóságának javítása
Könnyítse meg a kód karbantartását
A kódolási konvenciók lehetnek dokumentált szabályok a csapatok számára, amelyeket követniük kell, vagy egyszerűen csak az Ön egyéni kódolási gyakorlata.
Ez az oldal a W3Schools által használt általános JavaScript-kódkonvenciókat ismerteti.
Olvassa el a következő „Bevált gyakorlatok” című fejezetet is, és tanulja meg, hogyan kerülheti el a kódolási buktatókat.
A W3schoolsnál a camelCase-t használjuk az azonosítónevekhez (változók és függvények).
Minden név betűvel kezdődik.
Az oldal alján egy szélesebb körű vitát talál a névadásról szabályokat.
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);Mindig tegyen szóközt az operátorok köré (=+ - */), és vessző után:
let x = y + z;
const myArray = ["Volvo", "Saab",
"Fiat"];Mindig használjon 2 szóközt a kódblokkok behúzásához:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}Ne használjon tabulátorokat (tabulátorokat) a behúzáshoz. A különböző szerkesztők eltérően értelmezik a tabulátorokat.
Az egyszerű állítások általános szabályai:
Az egyszerű állításokat mindig pontosvesszővel fejezzük be.
const cars = ["Volvo", "Saab",
"Fiat"];
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};Az összetett (összetett) állítások általános szabályai:
Helyezze a nyitó zárójelet az első sor végére.
Használjon egy szóközt a nyitó zárójel előtt.
Tegye a záró zárójelet egy új sorba, bevezető szóközök nélkül.
Az összetett állításokat ne fejezze be pontosvesszővel.
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";
}Az objektumdefiníciók általános szabályai:
Helyezze a nyitó zárójelet ugyanabba a sorba, mint az objektum neve.
Használjon kettőspontot és egy szóközt az egyes tulajdonságok és azok értéke között.
Használjon idézőjeleket a karakterlánc-értékek körül, ne a numerikus értékek körül.
Ne írjon vesszőt az utolsó tulajdonság-érték pár után.
Helyezze a zárókonzolt egy új sorra, anélkül vezető terek.
Az objektumdefiníciókat mindig pontosvesszővel fejezze be.
A rövid objektumok tömörítve, egy sorba írhatók, csak szóközök használatával tulajdonságok között, például:
Az olvashatóság érdekében kerülje a 80-nál hosszabb sorokat karakterek.
Ha egy JavaScript utasítás nem fér el egy sorba, a legjobb hely a törésre ez egy operátor vagy vessző után van.
document.getElementById("demo").innerHTML =
"Hello Dolly.";Próbálja ki Ön is →
<!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>
Mindig ugyanazt az elnevezési konvenciót használja az összes kódhoz. Például:
Változó- és függvénynevek camelCaseként írva
Globális változók NAGYBETŰVEL írva (mi nem, de ez van elég gyakori)
NAGYBETŐVEL írt állandók (például a PI).
Használjon kötőtyúkokat, camelCase-t vagy under_core a változónevekben?
Ezt a kérdést gyakran megvitatják a programozók. A válasz attól függ, hogy ki vagy kérdez:
Kötőjelek a HTML-ben és a CSS-ben:
A HTML5 attribútumok kezdődhetnek a data- (data-quantity, data-price) karakterekkel.
A CSS kötőjeleket használ a tulajdonságnevekben (font-size).
A kötőjelek összetéveszthetők kivonási kísérletekkel. A kötőjelek nem megengedettek a JavaScript-nevekben.
Aláhúzások:
Sok programozó szívesebben használja az aláhúzásjeleket (születési_dátum), különösen az SQL-ben adatbázisok.
Az aláhúzás gyakran használatos a PHP dokumentációjában.
PascalCase:
A PascalCase-t gyakran preferálják a C programozók.
camelCase:
A camelCase-t maga a JavaScript, a jQuery és más JavaScript használja könyvtárak.
Ne kezdje a neveket $jellel. Ez sok JavaScript-könyvtárnévvel ütközik.
Használjon egyszerű szintaxist a külső szkriptek betöltéséhez (a type attribútum nem szükséges):
<script src="myscript.js"></script>A "rendetlen" HTML-stílusok használata JavaScript-hibákat eredményezhet.
Ez a két JavaScript utasítás eltérő eredményt ad:
const obj = getElementById("Demo")
const obj = getElementById("demo")Ha lehetséges, használja ugyanazt az elnevezési konvenciót (mint a JavaScriptet) a HTML-ben.
Keresse fel a HTML-stílus útmutatót.
A HTML-fájloknak .html kiterjesztéssel kell rendelkezniük (a .htm engedélyezett). <p>A CSS-fájloknak .css kiterjesztéssel kell rendelkezniük.
A JavaScript-fájloknak .js kiterjesztéssel kell rendelkezniük.
A legtöbb webszerver (Apache, Unix) megkülönbözteti a kis- és nagybetűket a fájlnevekben:
A london.jpg nem érhető el London.jpg néven.
Más webszerverek (Microsoft, IIS) nem érzékenyek a kis- és nagybetűkre:
london.jpg London.jpg vagy london.jpg néven érhető el.
Ha vegyesen használ nagy- és kisbetűket, akkor rendkívülinek kell lennie következetes.
Ha kis- és nagybetűérzékeny szerverről költözik át egy kis- és nagybetűérzékeny szerverre, akár kicsi hibák tönkretehetik webhelyét.
A problémák elkerülése érdekében mindig használjon kisbetűs fájlneveket (ha lehetséges).
A számítógépek nem használják a kódolási konvenciókat. A legtöbb szabály megvan csekély hatással van a programok végrehajtására.
A behúzás és az extra szóközök kis szkripteknél nem jelentősek.
A fejlesztés alatt álló kódnál az olvashatóságot kell előnyben részesíteni. Nagyobb termelés a szkripteket minimálisra kell csökkenteni.