Kommentare
Ein HTML-Kommentar wird verwendet, um erläuternde Anmerkungen zum Markup hinzuzufügen oder um zu verhindern, dass der Browser bestimmte Teile des Dokuments interpretiert.
Kommentare beginnen mit der Zeichenfolge <!--
und enden mit der Zeichenfolge -->
, in der Regel mit Text dazwischen. Dieser Text darf nicht mit der Zeichenfolge >
oder ->
beginnen, darf nicht die Zeichenfolgen -->
oder --!>
enthalten und nicht mit der Zeichenfolge <!-
enden, wobei <!
erlaubt ist.
Der Browser ignoriert Kommentare beim Rendern des Codes. Mit anderen Worten, sie sind auf der Seite nicht sichtbar - nur im Code. HTML-Kommentare sind eine Möglichkeit, hilfreiche Anmerkungen zu Ihrem Code oder Ihrer Logik zu schreiben.
Das oben Gesagte gilt auch für XML-Kommentare. Darüber hinaus darf in XML, wie in SVG- oder MathML-Markup, ein Kommentar nicht die Zeichenfolge --
enthalten.
Kommentare können in einer einzelnen Zeile oder über mehrere Zeilen 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, ausgenommen:
<script>
,<style>
,<title>
,<textarea>
, da diese Elemente ihren Inhalt als Rohtext interpretieren.
Hinweis: Während <script>
-Elemente keine HTML-Kommentare haben sollten und stattdessen JavaScript-Kommentare nutzen sollten, gab es früher die Praxis, den gesamten Skriptinhalt in einen HTML-Kommentar einzuschließen, damit alte Browser, die JavaScript nicht unterstützen, ihn nicht als Text rendern. Dies ist jetzt ein veraltetes Merkmal von JavaScript selbst und sollte nicht mehr verwendet werden.
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, wie zum Beispiel vor einem HTML-Attribut.
Wie bei den meisten Programmiersprachen, die die <!-- -->
Kommentarsyntax verwenden, können Kommentare nicht verschachtelt werden. Mit anderen Worten: Die erste Instanz von -->
, die einer Instanz von <!--
folgt, schließt den Kommentar.
Obwohl Kommentare mit einem <
beginnen und in einem >
enden, sind Kommentare keine HTML-Elemente.
Spezifikationen
Specification |
---|
HTML Standard # comments |
Siehe auch
- Kommentare in JavaScript
- Kommentare in CSS
Comment
-API (Comment
erbt vonNode
)