HTML-Kommentare: Notizen im Quelltext
Kommentare sind Notizen im Code, die der Browser komplett ignoriert. Sie helfen dir (und allen die nach dir an der Seite arbeiten) den Überblick zu behalten. Die Syntax sieht so aus:
HTML-Code
<!-- Das hier ist ein Kommentar -->
<!-- Hauptnavigation: Start -->
<nav> ... </nav>
<!-- Hauptnavigation: Ende -->Alles zwischen <!-- und --> wird nicht angezeigt, auch über mehrere Zeilen hinweg. Das eignet sich für Erklärungen, für Markierungen wo ein Abschnitt beginnt und endet, oder um ein Stück Code testweise auszuknipsen ohne es zu löschen. Letzteres nennt man auskommentiern.
Wichtig: Kommentare sind nicht geheim
Jeder kann Kommentare lesen. Der Browser zeigt sie nicht an, aber sie werden ganz normal mit ausgeliefert. Ein Rechtsklick, "Seitenquelltext anzeigen", fertig. Also: keine Passwörter, keine internen Bemerkungen über Kunden, keine Zugangsdaten in Kommentare schreiben. Klingt selbstverständlich, ist aber alles schon passiert.
Typische Fehler
- Kommentare verschachteln geht nicht. Ein Kommentar im Kommentar endet beim ersten
-->, der Rest steht dann sichtbar auf der Seite. - Zwei Bindestriche mitten im Kommentar (
--) sind nicht erlaubt und können den Kommentar vorzeitig beenden. Einfach vermeiden. - Riesige auskommentierte Codeblöcke für immer liegen lassen. Zum Testen prima, aber irgendwann darf gelöscht werden, sonst schleppt die Seite unnötigen Ballast mit.
Ein Blick zurück
In der Frühzeit des Webs hatten Kommentare einen kuriosen Zweitjob: Der Internet Explorer verstand sogenannte Conditional Comments, mit denen man Code nur für bestimmte IE-Versionen ausliefern konnte. Ganze Generationen von Entwicklern haben damit Browserfehler umschifft. Diese Zeiten sind vorbei, die Technik ist Geschichte, aber wer alte Quelltexte liest wird sie noch finden. Mehr solcher Ausgrabungen gibt es im Retro-Web, zum Beispiel bei den Browserkriegen.
Kommentar-Hygiene: drei Regeln
Kommentare altern schlecht, deshalb ein kleines Regelwerk aus der Praxis. Erstens: Kommentiere das Warum, nicht das Was. <!-- Footer --> vor dem footer-Element ist Rauschen (das sagt das Tag ja selbst), <!-- Reihenfolge wichtig: Skript erwartet das Formular davor --> ist Gold. Zweitens: Auskommentierter Alt-Code ist eine Wanderdüne, nach zwei Wochen weiß niemand mehr ob er noch gebraucht wird. Rauswerfen, dafür gibt es Sicherungskopien. Drittens: Vor Veröffentlichung einmal die eigenen Kommentare gegenlesen, interne Notizen der Sorte "Chef will das so, frag nicht" sind im Quelltext öffentlich sichtbarr.
Kommentare als Werkzeug beim Lernen
Beim Lernen und Debuggen sind Kommentare dagegen ein aktives Werkzeug: Verdächtige Bereiche testweise auskommentieren und schauen, ob der Fehler verschwindet, ist die älteste Eingrenzungsmethode der Welt und funktioniert im HTML genauso wie im CSS (dort mit /* und */). Die Hälfte der Seite verschwindet? Dann sitzt der Fehler in der anderen Hälfte. So halbiert man sich in wenigen Schritten bis zur Ursache vor, ganz ohne Werkzeuge, nur mit spitzen Klammern und Geduldd.
Weiter im Lernpfad: Sonderzeichen · Zurück zur HTML-Übersicht