TOC

Wie schreibe ich Kommentare in JavaScript

Einführung

Bei der Programmierung ist unsere erste Überlegung normalerweise die Maschine - wie der Computer den von uns geschriebenen Code liest und interpretiert. Es ist jedoch ebenso wichtig, die Personen zu berücksichtigen, die den Code lesen und damit arbeiten. Unabhängig davon, ob Sie mit einem Team oder alleine arbeiten, müssen Sie lernen, Ihren Code für menschliche Leser richtig zu kommentieren und zu strukturieren.

Kommentare sind Anmerkungen im Quellcode eines Programms, die vom Interpreter ignoriert werden und daher keinen Einfluss auf die tatsächliche Ausgabe des Codes haben. Kommentare können immens hilfreich sein, wenn es darum geht, die Absicht Ihres Codes zu erklären.

Als Entwickler kann es frustrierend sein, sich mit Code zu befassen, der von einer anderen Person geschrieben wurde, die nicht ordnungsgemäß kommentiert wurde, und es ist bemerkenswert einfach zu vergessen, was Ihr eigener Code bedeutete, wenn Sie nicht mehr in den Kontext eines Programms eingetaucht sind. Durch frühzeitiges Kommentieren Ihres Codes werden gute Programmiergewohnheiten im Laufe Ihrer Karriere gestärkt, um diese Probleme später zu vermeiden.

Werfen wir einen kurzen Blick auf die zwei verschiedenen Arten der JavaScript-Kommentarsyntax.

Single-line Kommentare werden mit zwei Schrägstrichen (//) geschrieben: 

// This is a comment

Alle Zeichen, die unmittelbar bis zum Ende der Zeile der Syntax von//folgen, werden von JavaScript ignoriert.

Block Kommentare, manchmal auch alsmutli-line Kommentare bezeichnet, werden mit öffnenden Tags (/*) und schließenden Tags (*/) geschrieben. Wenn Sie CSS kennen, sind Sie bereits mit Kommentaren auf Blockebene vertraut. 

/* This is
a comment */

Alles zwischen dem öffnenden und schließenden Tag im obigen Codeblock wird ignoriert.

Sowohl einzeilige als auch mehrzeilige Kommentare werden über den Code geschrieben, den sie erklären sollen, wie in diesem Beispiel „Hallo Welt!“ Gezeigt:

hello.js

// Print "Hello, World!" to the console
console.log("Hello, World!");

Wenn Sie Kommentare schreiben, rücken Sie sie auf derselben Ebene ein wie den Code direkt darunter:

ocean.js

// Initialize a function
function alphabetizeOceans() {
    // Define oceans variable as a list of strings
    const oceans = ["Pacific", "Atlantic", "Indian", "Antarctic", "Arctic"];

    // Print alphabetized array to the console
    console.log(oceans.sort());
}

Beachten Sie, dass Kommentare genauso Teil des Codes sind wie das Programm selbst. Veraltete Kommentare können eher ein Nachteil als gar kein Kommentar sein. Denken Sie also daran, die Kommentare regelmäßig zu pflegen und zu aktualisieren, zusammen mit allem anderen.

Einzeilige Kommentare werden alsinline comments bezeichnet, wenn sie am Ende einer Codezeile erscheinen. 

let x = 99;    // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y

Inline-Kommentare können zur schnellen Kommentierung kleiner, spezifischer Inhaltsausschnitte verwendet werden. Da sich der Kommentar nur auf die genaue Zeile beziehen sollte, in der er geschrieben ist, ist er der offensichtlichste Kommentartyp.

Denken Sie daran, dass es keine Möglichkeit gibt, einen einzeiligen Kommentar in einer Zeile zu beenden. Stellen Sie daher sicher, dass Sie keinen Code nach der Syntax von//einfügen, wie im folgenden Beispiel gezeigt.

broken.js

for (let i = 0; i === 10; i++) // for loop that runs ten times {
    // Running this code results in a syntax error
}

Obwohl Inline-Kommentare nützlich sein können, sollten sie sparsam verwendet werden - Code, der in einer Fülle von Inline-Kommentaren enthalten ist, wird schnell unübersichtlich und daher schwer lesbar.

Kommentare auf Blockebene oder mehrzeilige Kommentare sind lange Anmerkungen, mit denen ein Codeabschnitt eingeführt und erläutert wird. Häufig werden diese Kommentartypen am Anfang einer Datei oder vor einem besonders komplexen Codeblock platziert.

greet.js

/* Initialize and invoke a the greetUser function
to assign user's name to a constant and print out
a greeting. */

function greetUser() {
    const name = prompt("What is your name?");
    console.log("Hello ," + name + "! How are you?");
}

greetUser();

Manchmal wird auch eine leicht modifizierte Version der Blockkommentarsyntax angezeigt, die mit/** beginnt und Sternchen auf der linken Seite des Kommentarblocks enthält.

sea.js

/**
 * Initialize constant with an array of strings.
 * Loop through each item in the array and print
 * it to the console.
 */

const seaCreatures = ["Shark", "Fish", "Octopus"];

for (const seaCreature of seaCreatures) {
  console.log(seaCreature);
}

Manchmal enthält dieser Kommentartyp auch Details zur Programmdatei, einschließlich des Skriptnamens, der Version und des Autors.

Wenn Sie ein Anfänger in JavaScript sind, können Sie so viel wie nötig schreiben, um den von Ihnen geschriebenen Code zu lernen und zu verstehen. Wenn Sie sich als JavaScript-Entwickler weiterentwickeln, werden Sie versuchen, die Absicht oder diewhy hinter dem Code zu beantworten, im Gegensatz zu denhow oderwhat.

Kommentare können auch verwendet werden, um die Ausführung von Code zu Test- und Debugging-Zwecken schnell und einfach zu verhindern. Dies wird als "Auskommentieren von Code" bezeichnet.

Wenn in einem von Ihnen geschriebenen Code ein Fehler auftritt, können Abschnitte nicht ausgeführt werden, wenn Sie sie auskommentieren. Dies kann hilfreich sein, um die Ursache des Problems zu ermitteln. Sie können damit auch zwischen den Codes wechseln, um verschiedene Ergebnisse zu testen.

math.js

// Function to add two numbers
function addTwoNumbers(x, y) {
  let sum = x + y;
  return sum;
}

// Function to multiply two numbers
function multiplyTwoNumbers(x, y) {
  let product = x * y;
  return product;
}

/* In this example, we're commenting out the addTwoNumbers
function, therefore preventing it from executing. Only the
multiplyTwoNumbers function will run */

// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

Abhängig von der Größe des zu umschaltenden Abschnitts können sowohl einzeilige Kommentare als auch Blockkommentare zum Auskommentieren von Code verwendet werden.

[.note] #Note: Das Auskommentieren von Code sollte nur zu Testzwecken erfolgen. Hinterlassen Sie keine Ausschnitte aus auskommentiertem Code in Ihrem endgültigen Skript.
#

Wenn Sie die Logik eines Programms ausarbeiten, kann sich das Auskommentieren von Code als hilfreich erweisen, wenn Sie feststellen, wo sich Fehler befinden, oder wenn Sie die Codezeilen bewerten, die den größten Nutzen bieten.

Fazit

JavaScript-Code wird vom Computer interpretiert, aber immer von anderen Programmierern gelesen, einschließlich Ihres zukünftigen Selbst. Wenn Sie sich die Zeit nehmen, um komplizierte Codeabschnitte ordnungsgemäß mit Anmerkungen zu versehen, zahlt sich dies in Zukunft aus, sodass Sie und Mitarbeiter die Absicht des von Ihnen geschriebenen Codes besser verstehen können.

Related