In HTML einen Kommentar einfügen

Welche Arten von HTML-Kommentaren gibt es?

HTML-Kommentare erscheinen nicht im Frontend-Bereich und haben den Vorteil, dass man für andere Entwickler, die an dem Code mitarbeiten, Hinweise einfügen kann. Außerdem kann ein HTML-Kommentar ebenfalls zum sogenannten "Auskommentieren" dienen. Das heißt, Sie können Code-Passagen deaktivieren, damit sie im Browser nicht ausgeführt werden. Dies hilft beim Debugging, also der Behebung von Fehlern im HTML-Code. Darüber hinaus können Sie nach vielen Jahren immer noch nachvollziehen, weshalb Sie den Code so geschrieben haben, wie er dort steht.

Ein Kommentar wird folgendermaßen geschrieben

Sie können einen Kommentar entweder in eine eigene Zeile schreiben oder aber in die gleiche Zeile wie Ihr Code. Hier ein Beispiel:

<a href="#">Ihr Codebeispiel</a> <!-- Ihr individueller Kommentar hier -->

Sie beginnen also mit einer spitzen Klammer (englisch: "angle brackets"), die nach links zeigt. Danach schreiben Sie direkt dahinter ohne Leerzeichen ein Ausrufezeichen und dann zwei Bindestriche. Anschließend schreiben Sie durch ein Leerzeichen getrennt Ihren ganz persönlichen Kommentar.

Der Kommentar sieht dann z. B. so aus:

• <!-- Anfang der geordneten Liste für die Küchenrezepte -->
  
• <!-- Beginn der Tabelle über das Bruttoinlandsprodukt in den letzten 10 Jahren -->
  
• <!-- Hervorgehobener Content-Bereich -->
  

Sie geben danach wieder ein Leerzeichen ein und schließen den Kommentar mit zwei Bindestrichen und einer spitzen Klammer, die nach rechts zeigt. 

Wenn Sie nun einen mehrzeiligen HTML-Kommentar benötigen, geht dies mit der gleichen Syntax. Ein Beispiel:

<!-- Dies ist mein langer, mehrzeiliger Text,

den ich mir ausgedacht habe, um Ihnen zu

demonstrieren, wie Sie einen mehrzeiligen

Kommentar in HTML schreiben können. -->

Darüber hinaus können Sie sogenannte "Inline-Kommentare" schreiben. "Inline" bedeutet, dass der Kommentar innerhalb des Codes steht. Hier ein Beispiel:

<button>Bitte klicken <!-- Bitte machen Sie alle Buttons grün. --></button>

Bei dem Inline-Kommentar ist ebenfalls die Syntax genauso wie bei den ein- und mehrzeiligen Kommentaren.

Diese Punkte sollten Sie beachten, wenn Sie HTML-Kommentare einfügen

Es gibt einige Punkte, die Sie beachten sollten, wenn Sie HTML-Kommentare in Ihren Code einfügen.

• Überlegen Sie gut, in welcher Sprache Sie Ihren Code und die Kommentare schreiben. Sollte nichts anderes vorgegeben sein, schreiben Sie den Code idealerweise auf Englisch. Dies garantiert, dass Ihre Webseiten-Auszeichnungssprache weltweit verstanden wird.
• Achten Sie auf die genaue Syntax. Wenn Sie nur ein einziges Zeichen falsch schreiben, wird Ihr Code nicht funktionieren.
• Denken Sie auf jeden Fall daran, die spitzen Klammern zu verwenden, die sich auf einer deutschen Tastatur auf der zweiten Taste von links in der zweiten Zeile von unten befinden.
• Schreiben Sie Ihre Kommentare so sachlich und kurz wie möglich. Der HTML-Kommentar sollte jedoch alle notwendigen Informationen für die am Code mitarbeitenden Entwickler beinhalten.

Das Auskommentieren und die Nutzung für das leichtere Nachvollziehen und Debugging des Codes sind sehr hilfreich und nützlich. Sie haben nun kennengelernt, wie Sie ganz einfach mit ein paar Zeichen einen individuellen HTML-Kommentar schreiben können. Viel Spaß beim Coden!