HTML5: Kommentare in HTML

Vor zu Semantik, Funktion und Typen von Elementen

Zur besseren Verständlichkeit des eigenen Quelltextes ist es sinnvoll, diesen regelmäßig mit Kommentaren zu versehen. Sollte eines Tages ein anderer Entwickler an dem Quelltext arbeiten, können Kommentare sehr hilfreich sein, ebenso wenn die eigene Bearbeitungszeit länger zurückliegt. Bei stark verschachtelten gleichen Elementen kann es zudem sehr helfen, die Endmarkierungen speziell mit Kommentaren zu kennzeichnen, um sie sofort zuordnen zu können.

Eine weitere Anwendung insbesondere während der Entwicklung eines Dokumentes kann darin liegen, (vorübergehend) Teile des Quelltextes auszukommentieren, damit sie nicht interpretiert werden.

Kommentare werden in HTML mit einem Kleiner-als-Zeichen, einem Ausrufezeichen sowie zwei Bindestrichen eröffnet. Anschließend folgt der Inhalt des Kommentars. Geschlossen wird der Kommentar mit zwei Bindestrichen und einem Größer-als-Zeichen. Dabei kann sich ein Kommentar auf eine oder mehrere Zeilen erstrecken. Zwei aufeinanderfolgende Bindestriche sind innerhalb eines Kommentars unzulässig, folglich kann innerhalb eines Kommentares kein weiterer Kommentar notiert werden.

Beispiel:

<!-- Hier steht ein Kommentar mit einer Zeile -->

<!--
1. Zeile des Kommentars
2. Zeile des Kommentars
...

sonst fehlerhafter Kram darf hier ebenfalls stehen, 
weil er nicht interpretiert wird:

</

p>

& >

<>

<- - - ->
-->

Wo sind Kommentare erlaubt?

Kommentare dürfen an fast jeder beliebigen Stelle eines Dokuments stehen.

An folgenden Stellen dürfen Kommentare stehen:

Innerhalb von Elementen

<blockquote cite="http://de.wikisource.org/wiki/Faust_I">
<div>
 Mit Eifer hab’ ich mich der Studien beflissen,<br />
 Zwar weiß ich viel, doch möcht’ ich alles wissen.
 <!-- 600/601 -->
</div>
</blockquote>

Nach der XML-Deklaration (die XML-Verarbeitungsanweisung ist nur bei XML-Notation verfügbar)

<?xml version="1.0" ?>
<!-- Stilvorlage erstmal nur zum Testen -->
<?xml-stylesheet href="test1.css" type="text/css" title="Test 1" alternate="yes"?>
<html xmlns="http://www.w3.org/1999/xhtml">

Vor oder nach der Dokumenttypdeklaration

<?xml version="1.0" ?>
<?xml-stylesheet href="test1.css" type="text/css" title="Test 1" alternate="yes"?>
<!-- Stilvorlage erstmal nur zum Testen -->
<!DOCTYPE html>
<!-- Testseite für Stilvorlagen -->
<html xmlns="http://www.w3.org/1999/xhtml">

Im internen Unterbereich der Dokumenttypdefinition (nur die XML-Variante)

<!DOCTYPE html 
  [
<!--MeinDing definieren-->
<!ENTITY MeinDing "Das ist mein Ding!"> 
  ] >

Am Ende des Dokumentes nach dem Wurzelelement (hinter der Endmarkierung des Elementes html)

...
</html>
<!-- zuletzt geändert am 2018-10-02T17:18:19.20Z von Arti Fischl -->

An folgenden Stellen dürfen Kommentare nicht stehen:

Kommentare dürfen nicht innerhalb einer Elementmarkierung stehen.
Kommentare dürfen nicht vor einer dem Dokument eventuell voranstehenden XML-Deklaration stehen.

Zurück zu Dateiendungen |

Hoch zum Inhaltsverzeichnis |

Vor zu Semantik, Funktion und Typen von Elementen