HTML-Kommentare (<!-- … -->)
Ein HTML-Kommentar wird verwendet, um erklärende Notizen in das Markup einzufügen oder um zu verhindern, dass der Browser bestimmte Teile des Dokuments interpretiert.
Kommentare beginnen mit der Zeichenfolge <!--
und enden mit der Zeichenfolge -->
, normalerweise mit Text dazwischen. Dieser Text darf nicht mit der Zeichenfolge >
oder ->
beginnen, die Zeichenfolgen -->
oder --!>
enthalten, oder mit der Zeichenfolge <!-
enden, obwohl <!
erlaubt ist.
Der Browser ignoriert Kommentare während des Renderns des Codes. Anders ausgedrückt, sie sind nicht auf der Seite sichtbar - nur im Code. HTML-Kommentare sind eine Möglichkeit, hilfreiche Notizen zu Ihrem Code oder Ihrer Logik zu schreiben.
Das oben Gesagte gilt auch für XML-Kommentare. Zusätzlich gilt in XML, wie beispielsweise in SVG- oder MathML-Markup, dass ein Kommentar nicht die Zeichenfolge --
enthalten darf.
Kommentare können eine einzelne Zeile umfassen oder über mehrere Zeilen hinweg verwendet werden. Sie können an den folgenden Stellen eingesetzt werden:
- Vor und nach dem Doctype
- Vor und nach dem
<html>
-Element - Als Inhalt der meisten Elemente, außer:
<script>
,<style>
,<title>
,<textarea>
, da diese Elemente ihren Inhalt als Rohtext interpretieren
Hinweis:
Während <script>
-Elemente keine HTML-Kommentare enthalten sollten und stattdessen JavaScript-Kommentare verwenden sollten, gab es eine ältere Praxis, den gesamten Skriptinhalt in einem HTML-Kommentar einzuschließen, damit alte Browser, die kein JavaScript unterstützen, diesen nicht als Text rendern. Dies ist heute ein veraltetes Feature von JavaScript selbst, und Sie sollten sich nicht darauf verlassen.
Syntax
<!-- Comment -->
Beispiele
<!-- A one-line comment -->
<!--
A comment
that stretches
over several
lines
-->
<!-- The comment below disables
the HTML contained within -->
<!--
<p>
This content will not be rendered.
</p>
-->
Hinweise
HTML-Kommentare sind nur als Inhalt zulässig. Sie können nicht innerhalb eines Tags verwendet werden, z. B. vor einem HTML-Attribut.
Wie bei den meisten Programmiersprachen, die die Kommentarsyntax <!-- -->
verwenden, können Kommentare nicht verschachtelt werden. Anders ausgedrückt: Die erste Instanz von -->
, die nach einer Instanz von <!--
folgt, schließt den Kommentar.
Obwohl Kommentare mit einem <
beginnen und mit einem >
enden, ist ein Kommentar kein HTML-Element.
Spezifikationen
Specification |
---|
HTML # comments |
Siehe auch
- Kommentare in JavaScript
- Kommentare in CSS
Comment
-API (Comment
erbt vonNode
)