Rheinwerk Computing :: Einstieg in JavaScript

1.11 Kommentare

Kommentare dienen zur Beschreibung der einzelnen Teile Ihrer Programme. Sie erleichtern Ihnen und anderen den Einstieg in ein vorhandenes Programm. Betrachten wir ein Beispiel:

...
<body>
   <!-- Das ist ein Kommentar
        im HTML-Bereich -->
   <p>Ein Absatz aus dem HTML-Bereich</p>
   <script>

      /* Das ist ein Kommentar über mehrere Zeilen
         im JavaScript-Bereich */
      document.write("<p>Ein Absatz aus dem JS-Bereich</p>");
      // Ein kurzer Kommentar, nur bis zum Zeilenende

   </script>
</body></html>

Listing 1.6 Datei »kommentar.htm«

Im Beispiel sehen Sie drei verschiedene Arten von Kommentaren:

Ein Kommentar im HTML-Bereich kann sich über eine oder mehrere Zeilen erstrecken. Er steht zwischen den Zeichenfolgen .

Im JavaScript-Bereich wird ein Kommentar, der über eine oder mehrere Zeilen geht, zwischen den Zeichenfolgen /* und */ notiert.

Falls Sie nur einen kurzen Kommentar im JavaScript-Bereich notieren möchten, z. B. hinter einer Anweisung, so eignet sich die Zeichenfolge //. Dieser einzeilige Kommentar geht nur bis zum Ende der jeweiligen Zeile.

Der Inhalt der Kommentare wird nicht im Browser dargestellt, siehe Abbildung 1.5. Natürlich kann jeder Benutzer bei Bedarf den Quelltext der Seite ansehen und damit auch die Kommentare.

Hinweis

Häufig möchten Sie ein Programm, das von Ihnen oder von jemand anderem stammt, nach längerer Zeit noch einmal ansehen oder erweitern. Dann werden Sie für jede Zeile Kommentar dankbar sein, die Sie darin vorfinden. Aus den gleichen Gründen ist es auch sehr zu empfehlen, übersichtliche, leicht lesbare Programme zu schreiben.

Abbildung 1.5 Kommentare sind nicht sichtbar.