Detaillierte Einführung in den JavaScript-Coding-Styleguide

1. Grundformat

Einrückung

Es wird empfohlen, für den Editor , automatisch konvertieren

Semikolons

Semikolons nicht weglassen, um ASI-Fehler (automatische Semikoloneinfügung) zu vermeiden

Linienbreite

Jede Codezeile sollte 80 Zeichen nicht überschreiten. Wenn sie zu lang ist, sollten Sie den Operator verwenden, um die Zeile manuell umzubrechen

Zeilenumbruch

Der Operator steht am Ende der vorherigen Zeile und die nächste Zeile ist um 2 Ebenen eingerückt. Wenn es sich um eine Zuweisungsanweisung handelt, sollte sie auch an dem Teil nach dem Gleichheitszeichen ausgerichtet sein

Leerzeile

Funktions--Deklaration und Funktionsdeklarationen, Variablendeklarationen, Funktionsdeklarationen und Logikblöcke innerhalb von Funktionen sollten alle durch Leerzeilen getrennt werden

Der Autor Nicholas empfiehlt außerdem, oben im Block

Flusskontrolle eine Leerzeile zu lassen, aber das gegebene Beispiel ist nicht sehr klar

Benennung

• Variablenname/Funktionsname: Kamelregel (Kamelfall), zuerst Der erste Buchstabe des Wortes ist Kleinbuchstabe, der erste Buchstabe der nachfolgenden Wörter ist Großbuchstabe und der Rest ist Kleinbuchstabe

• KonstanteName: C-Sprache Formel, alle Großbuchstaben, Unterstrich-Wortsegmentierung

• Konstruktor : Pascal-Regel, alle Anfangsbuchstaben werden groß geschrieben, der Rest sind Kleinbuchstaben

Literal

• String : in doppelte Anführungszeichen gesetzt, für Zeilenumbrüche den [+]-Operator verwenden, keine Escape-Zeichen verwenden

• Numerischer Wert: Lassen Sie den Teil vor und nicht weg Verwenden Sie nach dem Dezimalpunkt keine Oktalform.

• Null: Behandeln Sie Null nur als Konto von Objekt. Bitsymbol, nicht verwenden Verwenden Sie es nicht zum Erkennen formaler Parameter und auch nicht zum Erkennen nicht initialisierter Variablen.

• Undefiniert: Alle

  Objekte sollten auf Null initialisiert werden, um undefiniert und nicht initialisiert zu unterscheiden

• Objektliteral/Array-Literal: Deklarieren Sie keine Objekte und Arrays im Konstruktormodus

2.

Hinweise

P.S. Es gibt eine sehr klassische Erklärung in dem Buch:

Angemessen geschriebene Kommentare helfen, die Geschichte des Codes zu erzählen,

allesdadurch können andere Entwickler ohne Notwendigkeit in einen Teil der Geschichte eintauchen Hören Sie den Anfang.

Einzeilige Kommentare

• Zeilenende: Level 1 verwenden. Einrückung trennt Code, und es sollte ein Leerzeichen vorhanden sein nach //

• in einer eigenen Zeile: Wird zum Kommentieren unten verwendet, und die gleiche Einrückung wie im kommentierten Code sollte beibehalten werden

• Kopf von Zeile: Wird zum Kommentieren von mehrzeiligem Code verwendet

Mehrzeiliger Kommentar

wird zum Umschließen großer Kommentare verwendet, Empfohlen

Eclipse Stil, wie zum Beispiel

/*
 * comment line1
 * comment line2
 */

Hinweis:

• Lassen Sie eine Leerzeile über dem mehrzeiligen Kommentar

• *Lassen Sie nach dem Sternchen ein Leerzeichen

• Mehrzeilige Kommentare müssen mindestens drei Zeilen lang sein (da nach der ersten und letzten Zeile keine Kommentare stehen)

Wo Kommentare hinzugefügt werden können

• Nicht selbsterklärender Code

• Absichtlich Ja, aber es sieht so aus, als ob etwas nicht stimmt

• Browser-Hack

Dokumentationskommentare

Zu jeder Funktion sollten Kommentare hinzugefügt werden, einschließlich Funktionsbeschreibung, Parameter, Rückgabewerte, ausgegebene Fehler usw., wie zum Beispiel der empfohlene Eclipse-Stil:

/**
 * 添加指定元素到默认数组
 *
 * @method add
 * @param {Number} 将要添加的元素
 * @return {Boolean} 添加成功/失败
 * @throw {TypeError} 参数类型不匹配
 */
function add(item){
    if(typeof item === "number"){
        arr.push(item)
    }
    else{
        throw new TypeError();
    }
}

3. Anweisungen und Ausdrücke

Ausrichtung von Klammern

Zeilenende-Stil wird empfohlen, Unterzeilen-Stil wird nicht empfohlen

Anweisungsleerzeichen blockieren

Es gibt ein Leerzeichen vor und nach den Klammern nach if, zum Beispiel:

if (expr) {
    code
}

switch-Anweisung

• Einrückung: Groß-/Kleinschreibung am Schalter ausrichten,

  UmbruchEinrückung 1 Ebene

• Groß-/Kleinschreibung durch: Verwenden Sie eine Leerzeile oder einen Kommentar, um anzugeben, dass die Groß-/Kleinschreibung beabsichtigt ist

• Standard: Standard beibehalten oder kommentieren //kein Standard, um anzuzeigen, dass es keinen Standard gibt

P.S. "

JavaScript „Language Essence“ Der Autor Douglas ist der Meinung, dass die Groß-/Kleinschreibung nicht verwendet werden sollte (und nennt sie nutzlos), da sie leicht zu Fehlern führen kann, während Nicholas glaubt, dass es besser ist, Leerzeilen oder Kommentare

mit zu verwenden Anweisung

Keine Notwendigkeit

for-Schleife

Alle Variablen sollten oben im Funktionskörper deklariert werden, einschließlich der Variablen, die im Initialisierungsteil der for-Schleife verwendet werden, um Fehler zu vermeiden, die durch Hosting (Hochstufung) verursacht werden (globale Variablen können blockiert werden)

for-in-Schleife

sollte nicht zum Durchlaufen des Arrays verwendet werden. Denken Sie bei der Verwendung daran, hasOwnProperty-Filterung hinzuzufügen, wenn Sie den Prototyp absichtlich durchlaufen Eigenschaft , Sie sollten einen Kommentar zur Erklärung verwenden

4. Variablen, Funktionen, Operatoren

Variablendeklaration

Funktionskörper = Variablendeklaration + Funktionsdeklaration + logische Anweisung. Trennen Sie jeden Teil durch Leerzeilen.

Funktionsdeklaration

Deklarieren Sie niemals eine Funktionsdeklaration im if-Zweig, da dies von Browsern unterschiedlich verstanden wird ein standardmäßiger

Funktionsaufruf

ohne das Hinzufügen von Leerzeichen vor und nach den Klammern, um Verwechslungen mit Blockanweisungen zu vermeiden

Anonyme Funktion Sofort ausführen

Umschließen Sie die anonyme Funktion, die sofort ausgeführt wird, in Klammern, um Verwechslungen mit der Deklaration der anonymen Funktion zu vermeiden

Strikter Modus

Aktivieren Sie den strikten Modus nicht im globalen Bereich, sondern nur innerhalb der Funktion. Wenn Sie mehrere Funktionen aktivieren, können Sie anonyme Funktionen verwenden, um den strikten Modusbereich sofort auszuführen

Die Beurteilung ist gleich zu

Verwenden Sie nur === und !==

eval

Verwenden Sie nicht eval() und new Function(), Verwenden Sie eine anonyme Funktion, um setTimeout() und setInterval() zu optimieren

Grundlegender Verpackungstyp

Verwenden Sie nicht new Boolean(), new String(), new Number()

Das obige ist der detaillierte Inhalt vonDetaillierte Einführung in den JavaScript-Coding-Styleguide. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!