Aus zwei Gründen wird die Kommentarfunktion eingesetzt:
- Dokumentation des Quellcodes
Damit andere Webdesigner oder man selbst nach ein paar Wochen oder Monaten einen umfangreichen Quellcode nachvollziehen können, empfiehlt es sich, wichtige Abschnitte zu kommentieren. - Auskommentieren
Quellcode, der z.B. erst später zum Einsatz kommen soll, kann man „auskommentieren“,
d.h. er wird im Quellcode als Kommentar angezeigt, aber nicht ausgeführt.
Quellcode in PHP oder JavaScript:
- Einzeiliger Kommentar:
Den einzeiligen Kommentar leitet man mit zwei Schrägstrichen ein.// Ich bin ein einzeiliger Kommentar.
- Mehrzeiliger Kommentar
Der mehrzeilige Kommentar beginnt mit einem Schrägstrich und einem Sternchen. Er endet mit einem Sternchen und einem Schrägstrich./* Ich bin ein mehrzeiliger Kommentar. */
Beispiel:
/* ****************************** *** Ausgabe der Ergebnisse *** ******************************* */