In diesem Tutorial erfahren Sie anhand von Beispielen, welche JavaScript-Kommentare Sie verwenden sollten und wie Sie sie verwenden können.
JavaScript-Kommentare sind Hinweise, die ein Programmierer hinzufügen kann, um das Lesen und Verstehen des Codes zu erleichtern. Sie werden von JavaScript-Engines vollständig ignoriert.
Es gibt zwei Möglichkeiten, dem Code Kommentare hinzuzufügen:
//- Einzeilige Kommentare/* */-Mehrzeilige Kommentare
Einzeilige Kommentare
In JavaScript ist jede Zeile, die mit beginnt, //ein einzeiliger Kommentar. Beispielsweise,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Hier // printing name on the consoleist ein Kommentar.
Sie können auch einen einzeiligen Kommentar wie diesen verwenden:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Mehrzeilige Kommentare
In Javascript ist jeder Text zwischen /*und */ein mehrzeiliger Kommentar. Beispielsweise,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Da der Rest des Quellcodes zur Implementierung der Spielregeln verwendet wird, ist der obige Kommentar ein gutes Beispiel, bei dem Sie möglicherweise einen mehrzeiligen Kommentar verwenden.
Verwenden von Kommentaren zum Debuggen
Kommentare können auch verwendet werden, um Code zu deaktivieren und zu verhindern, dass er ausgeführt wird. Beispielsweise,
console.log("some code"); console.log("Error code); console.log("other code");
Wenn beim Ausführen des Programms eine Fehlermeldung angezeigt wird, können Sie mithilfe von Kommentaren die Ausführung deaktivieren, anstatt den fehleranfälligen Code zu entfernen. Dies kann ein wertvolles Debugging-Tool sein.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro-Tipp: Beachten Sie die Verknüpfung für die Verwendung von Kommentaren. es kann wirklich hilfreich sein. Für die meisten Code-Editoren gilt dies Ctrl + /für Windows und Cmd + /Mac.
Machen Sie Code leichter verständlich
Als JavaScript-Entwickler schreiben Sie nicht nur Code, sondern müssen möglicherweise auch den von anderen Entwicklern geschriebenen Code ändern.
Wenn Sie Kommentare zu Ihrem Code schreiben, können Sie den Code in Zukunft leichter verstehen. Außerdem können Ihre Entwicklerkollegen den Code leichter verstehen.
Verwenden Sie als Faustregel Kommentare, um zu erklären, warum Sie etwas getan haben und nicht, wie Sie etwas getan haben, und Sie sind gut.
Hinweis: Kommentare sollten nicht die Möglichkeit sein, schlecht geschriebenen Code auf Englisch zu erklären. Sie sollten immer gut strukturierten und selbsterklärenden Code schreiben. Und dann benutze Kommentare.
