Ein HTML-Kommentar ist eine Notiz im Quelltext, die der Browser nicht darstellt. Verborgen ist sie damit nicht: Wer den Quelltext ansieht, liest sie mit.
- HTML-Kommentar
Abschnitt im Quelltext, den der Browser bei der Darstellung übergeht.
Beispiel: „Ein HTML-Kommentar beginnt mit einer spitzen Klammer, einem Ausrufezeichen und zwei Bindestrichen.“
Wie er aussieht
<!-- Preistabelle, gepflegt über das CMS -->
<table>…</table>Alles zwischen den Markierungen wird nicht dargestellt. Der Kommentar darf über mehrere Zeilen gehen und ganze Abschnitte einschließen, was ihn zum schnellen Mittel macht, um etwas vorübergehend stillzulegen.
Nicht verborgen
Der Browser zeigt den Kommentar nicht an, überträgt ihn aber mit. Jeder, der den Quelltext ansieht, liest ihn mit, und Suchmaschinen laden ihn ebenfalls herunter.
Was dort also nicht hingehört: Zugangsdaten, interne Absprachen, Preise für einzelne Kunden, Notizen über Dritte. Die Regel ist schlicht, dass ein Kommentar so öffentlich ist wie die Seite selbst.
Was ein guter Kommentar leistet
Hilfreich sind Hinweise auf das Warum: weshalb ein Block so gebaut ist, welche Einschränkung dahintersteckt, wo der Inhalt herkommt. Was im Markup ohnehin steht, muss nicht wiederholt werden.
Im Produktionsbetrieb entfernen viele Werkzeuge Kommentare automatisch, um Bytes zu sparen. Verlassen sollte man sich darauf nicht.
In Vorlagen eines Redaktionssystems haben sie einen zweiten Nutzen: Sie markieren, wo ein Block anfängt und aufhört. Bei verschachtelten Bereichen spart das die Suche nach dem passenden schließenden Tag. Für die Fehlersuche im Browser sind sie ebenfalls brauchbar, weil sie im dargestellten Quelltext an derselben Stelle stehen wie in der Vorlage.