Ein Kommentar ist eine Notiz im Quelltext, die der Browser nicht darstellt. Er beginnt mit einer öffnenden Folge, endet mit einer schließenden und darf über mehrere Zeilen gehen.
Schreibweise
<!-- Ein einzeiliger Hinweis -->
<!--
Ein Kommentar über mehrere Zeilen,
etwa zur Erklärung eines Bausteins.
-->
<!-- <p>Vorübergehend abgeschaltet</p> -->Der dritte Fall ist der häufigste Gebrauch: Markup vorübergehend stilllegen, ohne es zu löschen.
Was Kommentare nicht sind
Sie sind nicht privat. Der Kommentar wird mit der Seite ausgeliefert und steht im Quelltext, den jeder ansehen kann. Was dort regelmäßig auftaucht und dort nicht hingehört:
- Interne Pfade und Serverangaben
- Zugangsdaten aus Testphasen
- Hinweise auf noch nicht veröffentlichte Vorhaben
- Abfällige Bemerkungen über Auftraggeber oder Vorgänger
Der letzte Punkt ist kein Scherz – es ist eine der zuverlässigsten Fundstellen beim Übernehmen fremder Projekte.
Zwei Fallstricke der Schreibweise
Erstens: Zwei Bindestriche innerhalb eines Kommentars sind nicht zulässig und können ihn vorzeitig beenden. Trennlinien aus Bindestrichen sind deshalb eine schlechte Idee:
<!-- ---------- Abschnitt ---------- --> <!-- vermeiden -->
<!-- === Abschnitt === --> <!-- unproblematisch -->Zweitens lassen sich Kommentare nicht verschachteln. Ein auskommentierter Bereich, der selbst schon einen Kommentar enthält, endet an dessen Ende – der Rest erscheint wieder auf der Seite.
Kommentare und Ladezeit
Jeder Kommentar wird übertragen. Bei einzelnen Zeilen ist das bedeutungslos; bei automatisch erzeugten Seiten mit Hunderten von Vorlagenkommentaren summiert es sich. Wer Kommentare zur Dokumentation braucht, behält sie – und entfernt sie beim Ausliefern automatisch, nicht von Hand.
Ein sinnvoller Einsatz
<!-- Navigation: Reihenfolge wird in der Verwaltung gepflegt -->
<nav aria-label="Hauptmenü">
…
</nav>
<!-- Ende Navigation -->Ein Kommentar sollte erklären, warum etwas so ist. Was dort steht, sieht man ohnehin.