JavaScript/Kommentar

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

Abschnitte im Quellcode, die als Kommentar gekennzeichnet sind, werden nicht als ausführbarer Code interpretiert. Sie sind beispielsweise sinnvoll, um interne Angaben zu Autor und Erstellungsdatum in einer Datei zu platzieren oder interne Anmerkungen zu bestimmten Textstellen zu machen. Auch werden oft durch Kommentare am Anfang von Skriptdateien Lizenzvereinbarungen direkt in den Quellcode geschrieben oder es wird einfach der Versionsverlauf dokumentiert.

Kommentare sind im einfachsten Fall ein Erklärungstext im Quellcode. Dies ist der ursprünglichste Verwendungszweck. Hierbei soll er den Leser dabei unterstützen, den Code zu verstehen. Die Wartbarkeit von Webseiten, Webanwendungen und Programmen wird so wesentlich unterstützt und vereinfacht. Ein Kommentar ist ein wichtiger elementarer Bestandteil einer jeden Programmier- und Auszeichnungssprache.

Durch geeignete Kommentare im Quellcode ist es auch möglich, eine Dokumentation oder Nachschlagewerk zu erstellen. Dazu müssen die Kommentarinhalte einer speziellen Syntax folgen, die das Programm zum Erstellen der Dokumentation vorgibt. Es gibt auch Bearbeitungsprogramme, welche Kommentare auswerten und im Editor als Hilfetext anzeigen.

Beim Schreiben und Testen von JavaScript kommt es häufig vor, dass bestimmte Bereiche auskommentiert werden. Hierdurch wird ein Entwicklungsstand nicht einfach verworfen, sondern verbleibt als Kommentar im Quellcode.


Mehrzeilige Kommentare[Bearbeiten]

Mehrzeilige Kommentare werden durch die Zeichenfolge /* eingeleitet und durch */ beendet. Alles was zwischen diesen beiden Zeichenfolgen steht, wird nicht als Quellcode interpretiert. Sie dürfen sich über mehrere Zeilen erstrecken. Eine Verschachtelung mehrzeiliger Kommentare ineinander ist nicht erlaubt.

Beispiel
 /* Programm zur Kreisberechnung
    Version vom 15.2.2011
    Autor: Matthias Apsel */
Beispiel
/* Falsche Berechnung und auch falsches Auskommentieren durch Verschachtelung
/* Umrechnung Bogenmaß nach Grad */
function RadianToDegree(radian)
{
  return (radian * 100 / Math.PI);
}
*/

/* Umrechnung Bogenmaß nach Grad */
function RadianToDegree(radian)
{
  return (radian * 180 / Math.PI);
}
Dieses Beispiel zeigt die falsche Verwendung mehrzeiliger Kommentare durch Verschachtelung.

Einzeilige Kommentare[Bearbeiten]

Einzeilige Kommentare werden mit // eingeleitet und erstrecken sich bis zum Ende der Zeile. Sie sind gut für kurze Erklärungen geeignet oder um einfach eine Zeile auszukommentieren. Ein großer Vorteil einzeiliger Kommentare ist, dass sie auch innerhalb von mehrzeiligen Kommentaren vorkommen dürfen, weil sie sich syntaktisch nicht überschneiden und erst gar nicht darin erkannt werden. Würde man nur mehrzeilige Kommentare verwenden, dann könnte man nicht einfach größere Passagen, die bereits mehrzeilige Kommentare enthalten, auskommentieren, da mehrzeilige Kommentare nicht verschachtelt werden dürfen.

Beispiel
var radius = 6371;                 // Mittlerer Erdradius in Kilometer
var umfang = 2 * Math.PI * radius; // Erdumfang

// Umrechnung Bogenmaß nach Grad
function RadianToDegree(radian)
{
  return (radian * 180 / Math.PI);
}

// Umrechnung Grad nach Bogenmaß
function DegreeToRadian(degree)
{
  return (degree * Math.PI / 180);
}
Beispiel
/* Falsche Berechnung
// Umrechnung Bogenmaß nach Grad
function RadianToDegree(radian)
{
  return (radian * 100 / Math.PI);
}
*/

// Umrechnung Bogenmaß nach Grad
function RadianToDegree(radian)
{
  return (radian * 180 / Math.PI);
}
Dieses Beispiel zeigt, dass man Passagen durch mehrzeilige Kommentare ausblenden kann, auch wenn sie einzeilige Kommentare enthalten.