Javascript Kommentare - Javascript

Einführung

Kommentare sind im Wesentlichen Text, der innerhalb des Codes platziert wird, um seine Funktionsweise zu erläutern. In JavaScript gibt es im Wesentlichen zwei Arten von Kommentaren: einzeilige Kommentare, die mit den Schrägstrichzeichen (//) beginnen, und mehrzeilige Kommentare, die zwischen /* und */ geschrieben werden.

Einzeilige Kommentare

Einzeiliger Kommentar wird verwendet, um den Code etwas näher zu erläutern. Beginnt mit // und erstreckt sich bis zum Ende der Zeile. Dies können auch für schnelles Debugging oder zum Deaktivieren von Code verwendet werden.

Markdown für einzeilige Kommentare:

//Hier beginnt ein einzeiliger Kommentar

Mehrzeilige Kommentare

Ein mehrzeiliger Kommentar wird verwendet, um ausführlichere Kommentare abzugeben und sich über mehrere Zeilen erstrecken. Beginnt mit /* und endet mit */. Es kann für die Erklärung des Codes oder auch für die vorübergehende Deaktivierung des Codes verwendet werden.

Markdown für mehrzeilige Kommentare:

/* Hier beginnt der mehrzeilige Kommentar
   Hier können weitere Erklärungen gemacht werden 
   oder zum Beispiel Code deaktiviert werden 
*/

Dokumentation Kommentare

Eine besondere Art von Kommentar ist der Dokumentationskommentar. Sie beginnen mit /** – also wie mehrzeilige Kommentare – können aber speziell für die Prozessdokumentation und -beschreibung eingesetzt werden. Normalerweise werden sie für Kommentare verwendet, die mit Code-Elementen wie Funktionen und Variablen verknüpft sind.

Markdown für Dokumentationskommentare:

/**
 * Kurzbeschreibung der Funktion oder Variable
 *
 * Eine vollständige Erklärung der Funktion oder Variable und 
 * eventuelle Parameter sollten hier erfolgen.
 * Mehrzeilige Kommentare sind möglic.
 */

Best Practices beim Verwenden von Kommentaren

Kommentare sollten nur so oft eingesetzt werden, wie es notwendig ist, um den Code besser zu verstehen. Überflüssige Kommentare können verwirrend sein und den Code schlechter lesbar machen.

Kommentare sollten in englischer Sprache verfasst sein, um die Lesbarkeit für internationale Zusammenarbeiten zu fördern.

Gute Kommentare beschreiben Warum – nicht Was.

Kommentare sollten regelmäßig aktualisiert, entfernt oder ersetzt werden, um eine Verwirrung zu vermeiden.

Fazit

Kommentare sind eine wichtige Methode für die Dokumentation und Erklärung von Code. Ein klarer und zuverlässiger Code kann verhindern, dass unerwartete Fehler oder unvorhersehbare Ergebnisse entstehen. Entscheidend für eine korrekte Verwendung von Kommentaren ist es, nur so wenig und vier dem Zweck angemessen einzusetzen. Die Verwaltung von Kommentaren ist eine wichtige Aufgabe und sollte regelmäßig durchgeführt werden.