So schreiben Sie Kommentare in JavaScript -Code

Kommentare sind Anmerkungen, die ein Programmierer in seinem Code hinterlässt, um es verständlicher zu machen. Die meisten Senior -Entwickler konzentrieren sich auf das Schreiben von Code, der effizient ist und von Computern leicht gelesen und interpretiert werden kann. Es ist jedoch von gleicher Bedeutung, den Code für die Menschen (die in Zukunft mit dem Code arbeiten werden) leicht lesbar zu machen. Ein Programmierer muss wissen, wie man Code richtig strukturiert, um es für den Menschen verständlicher zu machen.

Was sind Kommentare?

Kommentare können alles von einer einzelnen Zeilenerklärung bis zur Multi-Line-Beschreibung des Codes sein, die im Quellcode eines Programms geschrieben wird. Sie werden normalerweise verwendet, um Notizen in den komplexen Teilen des Quellcode zu hinterlassen, sodass jeder, der in Zukunft den Code betrachtet. Diese Praxis spart Zeit, da jeder den Zweck des Codes leicht verstehen kann, ohne sich bemühen.

Lassen Sie uns nun lernen, wie Sie den JavaScript -Quellcode ordnungsgemäß strukturieren, indem Sie verschiedene Arten von Kommentaren schreiben:

Arten von Kommentaren in JavaScript

JavaScript hat zwei Haupttypen von Kommentaren:

• Einzelzeilenkommentare.
• Multi-Line-Kommentare

Einzelzeilenkommentare: In JavaScript werden zwei Vorwärts-Schrägstriche (//) verwendet, um Einzelzeilen-Kommentare zu schreiben:

// ein einzelner Kommentar

Die Kommentare in einer Programmiersprache haben keinen Einfluss auf das tatsächliche Programm. Die Dolmetscher/Compiler von Programmiersprachen sind so gestaltet, dass sie alle Kommentare beim Interpretieren/Kompilieren eines Programms ignorieren.

Kommentare können ihre eigenen separaten Zeilen haben; Sie können auch mit einem anderen Code Inline hinzugefügt werden.

Inline -Kommentare: Wenn Einzelzeilen-Kommentare in derselben Zeile wie Code verwendet werden, werden sie als Inline-Kommentare bezeichnet:

Sei a = 30; // ein Inline -Kommentar
Sei B = a + 10; // 10 in "A" -Variable 10 hinzufügen und es "B" zuweisen

Die Inline -Kommentare werden verwendet, um die genaue Codezeile zu erklären, über die sie geschrieben sind. Sie können für eine bestimmte, kleine Beschreibung des in dieser Zeile vorhandenen Code verwendet werden.

Multi-Line-Kommentare: In JavaScript sind die Block-Kommentare die Multi-Line-Kommentare auf die gleiche Weise geschrieben, wie sie in CSS mit Öffnungs-Tags (/*) und Schließen von Tags (*/) geschrieben wurden:

/* Ein Block
Kommentar*/

Der gesamte Text zwischen den Eröffnungs- und Schluss -Tags wird von den Dolmetschern ignoriert.

Multi-Line-Kommentare oder Kommentare auf Blockebene werden verwendet, um eine detaillierte Beschreibung eines Codeabschnitts zu erklären und zu geben. Diese Art von Kommentaren befindet sich normalerweise oben in der Quellcode -Datei oder vor einem besonders komplexen Codeblock:

/* Den Namen des Benutzers abrufen
von einem Eingangsfeld
und es auf der Konsole anzeigen */
Funktion showuser ()
const name = dokument.getElementById ('Benutzername');
Konsole.Protokoll ("Hallo und Willkommen bei The LinuxHint.com, " + name +".");

ShowUser ();

Kommentieren Sie den Code zum Testen/Debuggen: Kommentare können verwendet werden, um die Ausführung eines Blockcode schnell und einfach zu verhindern. So viele hochrangige JavaScript -Entwickler verwenden auch Kommentare zum Testen und Debugging -Zwecke. Wenn Sie die Kommentar -Tags hinter einem Codeblock platzieren, wird er vom Interpreter ignoriert und wird nicht ausgeführt.

Kommentieren des Codes hilft bei der Steinwende der Ursache eines Fehlers im Code. Sie können auch verwendet werden, um verschiedene Codeblöcke zu testen, um unterschiedliche Ergebnisse zu erzielen:

// Funktion zum Teilen von zwei Zahlen
Funktionsabteilung (Dividende, Divisor)
lass quotient = dividend / divisor;
Rückgabequotient;

// Funktion zum Subtrahieren von zwei Zahlen
Funktionssubtraktion (Num1, Num2)
Sei sub = num1 - num2;
Return Sub;

/* In der folgenden Codezeile kommentieren wir den Funktionsaufruf der Divisionsfunktion. Daher wird nur die Funktion subtraction () aufgerufen und ausgeführt. */
// Abteilung (30, 5);
Multiplytwonumbers (9, 3);

Praktiken zum Schreiben eines guten JavaScript -Code

Hier werden wir die drei Best Practices zum Schreiben eines guten JavaScript -Codes besprechen:

Kommentare werden im Allgemeinen über dem Codeblock geschrieben, den sie erklären:

// zeige "Hallo, LinuxHint!"Auf der Konsole
Konsole.Log ("Hallo, LinuxHint!");

Nehmen Sie die Kommentare auf der gleichen Ebene wie der Code unmittelbar darunter:

// Funktionsdefinition
Funktion showuser ()
// den Benutzernamen abrufen
const name = dokument.getElementById ('Benutzername');
// Drucken Sie die Nachricht auf der Konsole
Konsole.Protokoll ("Hallo und Willkommen bei The LinuxHint.com, " + name +".");

Denken Sie daran, dass es keine Möglichkeit gibt, die Inline -Kommentare zu beenden. Sie sollten also erst geschrieben werden, nachdem der Code für diese Zeile vollständig geschrieben wurde:

für (sei i = 0; i === 10; i ++) // für Schleife, die zehnmal läuft
// Ausführen dieses Codes führt zu einem Syntaxfehler

Abschluss

Wie oft haben Sie ein komplexes Problem gelöst, indem Sie einen Code geschrieben haben, um ein paar Monate später zurückzukommen und herauszufinden, dass Sie sich erinnern und nichts verstehen? Kommentare helfen Ihnen, dies zu vermeiden, indem Sie detaillierte Erklärungen/Beschreibungen Ihres Codes schreiben. Sie helfen auch beim Debuggen von Tests und Steinpunkten der Fehlerquelle in Ihrem Code. Sowohl einzelne als auch multiline Kommentare können zum Debugging/Testzwecke verwendet werden. Wenn Sie ein JavaScript -Entwickler für Anfänger sind, sollten Sie so viele Kommentare wie möglich in Ihren Code schreiben, um den von Ihnen geschriebenen Code zu verstehen. Aber denken Sie daran, dass sie nur dort hinzugefügt werden sollten, wo sie benötigt werden.