Javascript-Kommentar

| | | | | | | | | | | | | | | | | | | |

JavaScript-Kommentare werden verwendet, um Notizen in Ihren Code zu schreiben oder Codeabschnitte zu deaktivieren, ohne sie zu löschen. Kommentare werden in JavaScript durch Hinzufugen von//vor einer einzelnen Zeile oder/*vor und*/nach mehreren Zeilen.

Kommentieren on code ist ein Kernfeature einer Reihe von Programmiersprachen. Die Idee hinter Codekommentaren ist, dass Ihr Code zwar vom Computer gelesen wird, Ihr Code jedoch auch von Menschen gelesen wird. Daher ist es wichtig, dass die Leute den von Ihnen geschriebenen Code leicht verstehen können.

Kommentare ermöglichen es Ihnen, Ihren Code während der Programmierung zu verfolgen, und geben Ihnen die Möglichkeit, Notizen zu machen, die später hilfreich sein können. Wenn Sie in einem Team arbeiten, können Sie durch das Schreiben von Kommentaren außerdem sicherstellen, dass Ihr Code fur alle lesbar ist, die möglicherweise zu Ihrer Arbeit beitragen mussen.

In diesem Tutorial werden wir diskutieren, wie Kommentare in JavaScript geschrieben werden. Wir beginnen damit, den Wert von Kommentaren in JavaScript zu besprechen, dann werden wir uns die Syntax ansehen, die Sie verwenden können, um Kommentare in JavaScript zu schreiben.

Kommentare zu Code schreiben

Kommentieren ist ein wesentlicher Bestandteil beim Schreiben von lesbarem und wartbarem Code. Die Wahrheit ist, dass Sie zwar den Code, den Sie heute schreiben, verstehen, es jedoch keine Garantie dafur gibt, dass Sie morgen effektiv beschreiben können, was er tut. Wenn Sie mit anderen zusammenarbeiten, besteht außerdem eine hohe Wahrscheinlichkeit, dass diese einen Teil des von Ihnen geschriebenen Codes nicht verstehen.

Hier kommen Kommentare ins Spiel. Kommentare sind Aussagen, die werden vom Compiler ignoriert und können verwendet werden, um Ihren JavaScript-Code zu erklären.

Als Entwickler können Sie durch das Schreiben von Kommentaren zu Ihrem eigenen Code effektiver verfolgen, was Sie tun. Während Sie Ihren Code schreiben, können Sie sich Notizen machen, die Ihnen helfen, Ihren Code besser zu verstehen und die Absicht hinter dem Code, den Sie zuvor geschrieben haben, herauszufinden. Das Verfassen von Kommentaren ist auch fur andere Personen hilfreich, die Ihren Code sehen, da der Kommentar ihnen wahrscheinlich hilft, die Funktionsweise Ihres Codes genauer zu verstehen.

Jeder Entwickler schreibt Kommentare anders, aber die allgemeine Regel ist, dass Kommentare verwendet werden sollten, um die Absicht hinter Ihrem Code zu erklären. Schließlich spricht Ihr Code fur sich selbst, aber die Grunde fur das Schreiben von Code auf eine bestimmte Weise tun dies oft nicht. Indem Sie also Kommentare schreiben, können Sie erklären, warum Sie ein Problem auf eine bestimmte Weise angegangen sind, sodass Sie und andere leichter verstehen, wie Ihr Programm später funktioniert.

JavaScript-Kommentare

In JavaScript werden zwei Arten von Kommentaren verwendet: einzeilige Kommentare und Blockkommentare.

Einzeilige Kommentare werden mit zwei Schr√§gstrichen (//) geschrieben und stehen auf eine Codezeile. Jedes Zeichen nach dem "//‚"Anweisung wird bis zum Ende der Zeile ignoriert. Hier ein Beispiel fur einen einzeiligen Kommentar in JavaScript:

// Dies ist ein einzeiliger Kommentar

Blockkommentare werden mit öffnenden und schließenden Tags geschrieben und ermöglichen es Ihnen, Kommentare zu schreiben, die sich uber mehrere Zeilen erstrecken. Die öffnenden und schließenden Tags fur Blockkommentare sind:

  • "/*‚" zum √ñffnen eines Kommentars
  • "*/‚" zum Schlie√üen eines Kommentars

Blockkommentare werden manchmal als mehrzeilige Kommentare bezeichnet und ähneln mehrzeiligen CSS-Kommentaren. Hier ein Beispiel fur einen Blockkommentar in JavaScript:

Der gesamte Code zwischen unseren öffnenden und schließenden Tags wird vom Compiler ignoriert.

Jede Art von Kommentar kann verwendet werden um Ihren Code zu erklären und die Absicht hinter Ihrem Code zu besprechen. Hier ist ein Beispiel fur einen Kommentar, der verwendet wird, um eine grundlegende Variablendeklaration zu erklären:

// Deklarieren Sie "Schokolade‚" Variable zum Speichern von Schokoladensorten als Array

var chocolate = [‘Dark’, ‘Milk’, ‘White’, ‘Haselnut’, ‘Caramel’];

Kommentare in jeder Programmiersprache sollten regelmäßig aktualisiert werden, wenn sich der Code ändert. Wenn wir also entschieden haben, dass unser Variablenname in "chocolate_types" Wir sollten unseren Kommentar aktualisieren, um sicherzustellen, dass er den neuen Variablennamen widerspiegelt. Wenn Programme größer werden, ändern sie sich oft erheblich, daher ist es wichtig, Ihre Kommentare zusammen mit Ihrem Code zu aktualisieren.

Code auskommentieren

Kommentare werden oft fur einen von zwei Zwecken verwendet: Der erste, wie wir in diesem Artikel besprochen haben, besteht darin, die Absicht Ihres Codes zu erklären und Verwirrungen zu klären Die zweite Möglichkeit besteht darin, die Ausfuhrung von Code während des Testens zu verhindern.

Das Auskommentieren von Code ermöglicht es Ihnen, die Ausfuhrung einer oder mehrerer Codezeilen zu stoppen, ohne den Code vollständig aus Ihrem Programm zu entfernen. Diese Verwendung von Kommentaren ist beim Debuggen ublich, da Sie möglicherweise mehrere Lösungen fur ein Problem ausprobieren und Ihren Code fur später aufbewahren möchten.

Hier ist ein Beispiel fur einen Kommentar, der auskommentiert Codezeile:

Wenn wir unser Programm ausfuhren, fuhrt der Compiler nur die Codezeile aus, die die Variable "Schokolade> deklariert.‚" Wir haben die Variable "flavors‚" auskommentiert, da sie einen Fehler enth√§lt und wir das Problem beheben mussen. In diesem Fall haben wir vergessen, ein Gleichheitszeichen zwischen unserem Variablennamen ("flavors‚") und dem Wert der Variablen (unserem Array von Flavors) zu setzen.

Lassen Sie uns jede der beiden besprochenen Arten von Kommentaren aufschlusseln und untersuchen, wie sie verwendet werden können.

Einzeilige Kommentare

Einzeilige Kommentare, auch bekannt als Inline-Kommentare werden verwendet, um einen Teil einer Codezeile oder eine ganze Codezeile zu kommentieren. Hier ein Beispiel fur einen einzeiligen JavaScript-Kommentar:

In diesem Kommentar deklarieren wir eine Variable "first_type‚", die den ersten Wert in unserem "Schokolade‚"-Array. Dann fugen wir am Ende unserer Zeile einen Inline-Kommentar hinzu, um die Absicht hinter unserem Code zu erl√§utern.

Einzeilige Kommentare werden im Allgemeinen verwendet, um kurze Kommentare zu Ihrem Code zu machen oder die Absicht hinter einer bestimmten Codezeile. Einzeilige Kommentare sind jedoch nicht die einzige Art von Kommentar, die Sie verwenden sollten. Wenn Sie eine größere Funktion erklären mussen, schreiben Sie am besten Blockkommentare.

Blockkommentare

Blockkommentare werden uber mehrere Zeilen geschrieben und werden verwendet, um einen größeren Codeabschnitt zu erklären. Während einzeilige Kommentare normalerweise eine Codezeile erklären, ein Blockkommentar kann eine Funktion oder den Zweck einer Datei erklären.

Mehrzeilige Kommentare beginnen in den meisten Fällen entweder am Anfang einer Funktion oder einer Datei. Hier ist ein Beispiel fur ein Blockkommentar, der verwendet wird, um eine for-Schleife zu erklären:

Unser Blockkommentar erstreckt sich uber drei Zeilen und wird verwendet, um den geschriebenen Code zu beschreiben zehn in unserem "fur‚" loop.

Blockkommentare können auch am Anfang einer Datei stehen, um den Zweck einer Datei zu erläutern oder Informationen uber den Autor und die Version der Datei aufzunehmen. Hier ein Beispiel fur ein Snippet, das den Autor einer Datei und das Erstellungsdatum in JavaScript enthält:

Schlussfolgerung

Wenn Sie Kommentare zu Ihrem Code schreiben, können Sie besser lesbare und wartbarer Code. Sie können Kommentare verwenden, um Ihren Code sowohl fur Ihr zukunftiges Ich im Auge zu behalten als auch anderen Personen, die mit Ihrem Code arbeiten, den Zweck zu erleichtern.

In diesem Tutorial haben wir die Grundlagen des Kommentierens und dann untersucht, wie man einen Kommentar in JavaScript schreibt. Wir haben auch die beiden Hauptarten von Kommentaren besprochen – einzeilige und mehrzeilige – und haben Beispiele fur jede Art von Codekommentar in Aktion gezeigt. Schließlich haben wir die Unterschiede zwischen dem Kommentieren und Auskommentieren von Code diskutiert.

Jetzt sind Sie bereit, Kommentare in JavaScript wie ein Experte zu schreiben!