Verwendung von HTML-Kommentaren <!-- … -->
Ein HTML-Kommentar wird verwendet, um erklärende 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 -->, wobei sich im Allgemeinen Text dazwischen befindet. Dieser Text darf nicht mit der Zeichenfolge > oder -> beginnen, darf die Zeichenfolgen --> oder --!> nicht enthalten, noch mit der Zeichenfolge <!- enden, obwohl <! erlaubt ist.
Der Browser ignoriert Kommentare beim Rendern des Codes. Mit anderen Worten, sie sind nicht auf der Seite sichtbar - nur im Code. HTML-Kommentare sind eine Möglichkeit, hilfreiche Anmerkungen zu Ihrem Code oder Ihrer Logik zu schreiben.
Das Obige gilt auch für XML-Kommentare. In XML, wie in SVG oder MathML-Markup, darf ein Kommentar zusätzlich nicht die Zeichenfolge -- enthalten.
Kommentare können in einer einzigen Zeile verwendet werden oder sich über mehrere Zeilen erstrecken. Sie können an den folgenden Stellen verwendet 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 haben sollten und stattdessen JavaScript-Kommentare verwenden sollten, gab es eine frühere 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 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 zugelassen. Sie können sie nicht innerhalb eines Tags verwenden, wie z.B. vor einem HTML-Attribut.
Wie bei den meisten Programmiersprachen, die die <!-- --> Kommentar-Syntax verwenden, können Kommentare nicht geschachtelt 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, handelt es sich bei einem Kommentar nicht um ein HTML-Element.
Spezifikationen
| Specification |
|---|
| HTML # comments |
Siehe auch
- Kommentare in JavaScript
- Kommentare in CSS
Comment-API (Commenterbt vonNode)