JavaScript-Stilrichtlinie
Alle JavaScript-Projekte folgen derselben Stilrichtlinie.
JavaScript-Stilrichtlinie
Eine Stilrichtlinie umfasst normalerweise die folgenden Aspekte:
- Namensregeln für Variablen und Funktionen
- Regeln für die Verwendung von Leerzeichen, Einrückungen und Kommentaren.
- Weitere übliche Konventionen...
Standardisierter Code ist leichter zu lesen und zu warten.
Code-Konventionen werden im Allgemeinen vor der Entwicklung definiert und können mit deinen Teammitgliedern ausgehandelt und festgelegt werden.
Variablennamen
Für Variablennamen wird camelCase empfohlen (camelCase):
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);
Leerzeichen und Operatoren
Üblicherweise sollten vor und nach Operatoren Leerzeichen eingefügt werden ( = + - * / ):
Beispiel:
var values = ["Volvo", "Saab", "Fiat"];
Code-Einrückung
Normalerweise werden 4 Leerzeichen verwendet, um Codeblöcke einzurücken:
Funktion:
return (5 / 9) * (fahrenheit - 32);
}
![]() |
Es wird nicht empfohlen, die TAB-Taste zum Einrücken zu verwenden, da verschiedene Editoren die TAB-Taste unterschiedlich interpretieren. |
|---|
Anweisungsregeln
Allgemeine Regeln für einfache Anweisungen:
- Eine Anweisung endet normalerweise mit einem Semikolon.
Beispiel:
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
Allgemeine Regeln für komplexe Anweisungen:
- Die öffnende geschweifte Klammer an das Ende der ersten Zeile setzen.
- Ein Leerzeichen vor der öffnenden geschweiften Klammer einfügen.
- Die schließende geschweifte Klammer in eine eigene Zeile setzen.
- Eine komplexe Anweisung mit einem Semikolon beenden.
Funktion:
return (5 / 9) * (fahrenheit - 32);
}
Schleifen:
x += i;
}
Bedingte Anweisungen:
greeting = "Good day";
} else {
greeting = "Good evening";
}
Objektregeln
Regeln für Objektdefinitionen:
- Setzen Sie die öffnende geschweifte Klammer auf dieselbe Zeile wie den Klassennamen.
- Zwischen dem Doppelpunkt und dem Eigenschaftswert steht ein Leerzeichen.
- Strings verwenden doppelte Anführungszeichen; Zahlen benötigen sie nicht.
- Fügen Sie nach dem letzten Eigenschaftswert kein Komma hinzu.
- Setzen Sie die schließende geschweifte Klammer in eine eigene Zeile und beenden Sie sie mit einem Semikolon.
Beispiel:
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
Kurzer Objektcode kann direkt in einer Zeile geschrieben werden:
Beispiel:
Jede Codezeile weniger als 80 Zeichen
Zum leichteren Lesen wird empfohlen, dass jede Zeile weniger als 80 Zeichen hat.
Wenn eine JavaScript-Anweisung 80 Zeichen überschreitet, wird empfohlen, die Zeile nach einem Operator oder Komma umzubrechen.
Beispiel:
"Hello Example.";
Probieren Sie es selbst aus »
Namensregeln
Im Allgemeinen haben viele Programmiersprachen ähnliche Namensregeln, zum Beispiel:
- Variablen und Funktionen werden mit Lower Camel Case identifiziert, das heißt, außer beim ersten Wort wird der erste Buchstabe der anderen Wörter großgeschrieben (lowerCamelCase)
- Globale Variablen werden in Großbuchstaben geschrieben (UPPERCASE )
- Konstanten (wie PI) werden in Großbuchstaben geschrieben (UPPERCASE )
Verwenden Sie diese Regeln für die Variablenbenennung:hyp-hens, camelCase, oderunder_scores ?
Das Bindestrich-Zeichen (-) in HTML und CSS:
HTML5-Attribute können data- als Präfix verwenden (z. B. data-quantity, data-price).
CSS verwendet - zum Verbinden von Eigenschaftsnamen (font-size).
![]() |
- wird in JavaScript normalerweise als Subtraktion betrachtet, daher ist es nicht erlaubt. |
|---|
Unterstrich:
Viele Programmierer verwenden bevorzugt Unterstriche (z. B. date_of_birth), insbesondere in SQL-Datenbanken.
Die Sprache PHP verwendet normalerweise Unterstriche.
PascalCase:
PascalCase ist in der Sprache C gebräuchlicher.
Camel Case:
Camel Case wird in JavaScript allgemein empfohlen; jQuery und andere JavaScript-Bibliotheken verwenden Camel Case.
![]() |
Variablennamen sollten nicht mit $ beginnen, da dies mit vielen JavaScript-Bibliotheken kollidiert. |
|---|
Externe JavaScript-Dateien in HTML laden
Verwenden Sie ein prägnantes Format zum Laden von JavaScript-Dateien (das type-Attribut ist nicht erforderlich):
Mit JavaScript auf HTML-Elemente zugreifen
Schlechte HTML-Formatierung kann JavaScript-Ausführungsfehler verursachen.
Die folgenden beiden JavaScript-Codes werden unterschiedliche Ergebnisse ausgeben:
Beispiel
var obj = getElementById("demo")
Probieren Sie es selbst aus »
Versuchen Sie, für HTML und JavaScript dieselben Benennungsregeln zu verwenden.
Besuchen Sie den HTML(5)-Styleguide。
Dateiendungen
HTML-Dateiendungen können.html(oder.html)。
Die CSS-Dateiendung ist.css 。
Die JavaScript-Dateiendung ist.js 。
Dateinamen in Kleinbuchstaben verwenden
Bei den meisten Webservern (Apache, IIS) wird zwischen Groß- und Kleinschreibung unterschieden: london.jpg kann nicht über London aufgerufen werden.
Bei anderen Webservern (Microsoft, IIS) wird nicht zwischen Groß- und Kleinschreibung unterschieden: london.jpg kann über London.jpg oder london.jpg aufgerufen werden.
Sie müssen einen einheitlichen Stil beibehalten, und wir werden durchgängig Dateinamen in Kleinbuchstaben verwenden.
Andere Erweiterungen