Kommentare einfügen im HTML5
Kommentare als Hinweise in HTML-Dokumenten
Wenn Sie in Ihre HTML-Dokumente Kommentare einfügen, können Sie damit kennzeichnen, wo Sektionen beginnen oder enden, für sich selbst (oder spätere Bearbeiter) Hinweise einflechten, wozu ein bestimmter Codeabschnitt gedacht ist, verhindern, dass Inhalte dargestellt werden, und vieles mehr. Diese Kommentare erscheinen nur, wenn das Dokument mit einem Editor oder über die Browser-Option Quelltext anzeigen geöffnet wird. Besucher sehen sie in ihrem Browser nicht.
In diesem Beispielcode stehen vier Kommentare. Zwei zeigen kombiniert Anfang und Ende des Artikels an. Mit dem nächsten wird der erste Absatz auskommentiert, damit er auf der Seite nicht dargestellt wird (wenn Sie auf lange Sicht diesen Absatz ausschließen wollen, wäre es besser, ihn im HTML zu löschen). Der letzte Kommentar ist eine Erinnerung, weitere Inhalte einzufügen, bevor die Seite live geschaltet wird.
Achten Sie allerdings genau darauf, solche temporären Kommentar wie To-do-Listen zu entfernen, bevor Sie die Seite veröffentlichen, falls sich Besucher Ihren Code ansehen.
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>HTML5 Lernen - Grundlagen und Tutorials</title>
</head>
<body>
<!-- ==== START ARTICLE ==== -->
<article class="html5-titel">
<h1 id="html5-article-titel-h1">
HTML5 Lernen - Grundlagen und Tutorials
</h1>
<!-- Dieser Absatz wird nicht dargestellt, weil er auskommentiert ist.
<p>HTML5 bietet neue Elemente für die Definition der Struktur einer Website und die Einbettung von Inhalten.</p>
-->
<p>
Die neuen Features von HTML5. So setzen Sie anspruchsvolle Web-Layouts mit HTML5. Wir wollen Ihnen einen ausführlichen Einblick in die neuen Möglichkeiten von HTML5 geben.
</p>
<section class="html5-titel">
<h2 id="html5-section-titel-h2" lang="de">
Der Titel im HTML5
</h2>
</section>
<section class="html5-titel">
<h2 id="html5-section-titel-h2">
Überschriften im HTML5
</h2>
</section>
</article>
<!-- Ende article -->
<!-- To Do: Hier noch einige Absätze einstellen, bevor die Seite live geht. -->
</body>
</html>
Kommentare auf einer HTML-Seite einfügen
- In Ihrem HTML-Dokument tippen Sie dort, wo Sie einen Kommentar einfügen wollen,
<!--ein. - Schreiben Sie die entsprechenden Kommentare.
- Mit Eingabe von
-->schließen Sie den kommentierten Text ab.
Kommentare sind unsichtbar (obwohl man sie lesen kann, wenn man sich den Quellcode anzeigen lässt). Entsprechend werden Inhalte, die Sie in Kommentarzeichen setzen, nicht dargestellt. Hier wird der erste Absatz im Code nicht gezeigt.
Meist nutzt man Kommentare dafür, sich (und zukünftige Bearbeiter) daran zu erinnern, bestimmte Abschnitte aufzunehmen, zu entfernen oder zu aktualisieren.
Ein weiterer Grund für Kommentare ist das Vermerken einer Revisionsnummer.
Üblicherweise fügt man zu Beginn und am Ende von größeren Codeabschnitten Kommentare ein, damit Sie und andere die Seiten einfacher bearbeiten können (Seiten können ganz schön lang werden). Ich nehme gerne ein auffälliges Format, wenn ich einen Kommentar beginne, und ein weniger deutliches fürs Ende, damit ich auf einen Blick schnell diese beiden wichtigen Punkte erkenne, wenn ich den Code überfliege.
Sie sollten sich Ihre kommentierte Seite mit einem Browser anschauen, bevor Sie sie veröffentlichen. So vermeiden Sie es, unabsichtlich vielleicht gar private Kommentare zu publizieren, weil ein Kommentar womöglich falsch formatiert wurde.
Vorsicht allerdings vor Kommentaren, die tatsächlich allzu privat sind. Man kann sie im Browser zwar nicht gleich sehen, aber sie können ganz einfach sichtbar gemacht werden, wenn der User sich die Seite über die Option QUELLCODE ANZEIGEN anschaut oder die Seite als HTML-Quellcode speichert.
Kommentare sollten nicht in anderen Kommentaren verschachtelt werden.
Die hier gezeigte Syntax gilt nur für HTML-Kommentare. CSS und JavaScript haben eine andere Kommentarsyntax. CSS und JavaScript arbeiten beide mit /* Hier kommt der Kommentar */ für einen Kommentar, der über eine oder mehrere Zeilen geht, während bei JavaScript noch die Schreibweise // Hier kommt der Kommentar für einzeilige Kommentare möglich ist.