Sie sind hier : sebastian1012.bplaced.net/ homepage-neu / kreuz-und-quer / tutorials-info-neuigkeiten-html / html-kommentare-weg-damit.php

HTML-Kommentare: Weg damit!

Kommentare bietet fast jede Programmier- bzw. Scriptsprache. Sie dienen dazu, dass auch andere Entwickler den erstellten Code auf Anhieb verstehen und sich nicht erst mühsam hineinarbeiten müssen. Andererseits sind sie auch ganz nützlich, wenn man nach Monaten oder Jahren eine Änderung an einem (eigenen) Script oder Programm durchführen möchte. Ohne Kommentare versteht man manchmal den eigenen Code nicht mehr.
Auch HTML bietet diese Funktion. Doch ist diese unter bestimmten Bedingungen nur sehr beschränkt nützlich und nötig.

Kommentare werden in HTML so erstellt:

<!-- Dies ist ein HTML-Kommentar -->

Immer wieder sehe ich bei Scripts, dass derzeit nicht benötigte Code-Teile einfach auskommentiert werden, weil man sie eventuell später nochmal benötigt. Das ist auch sinnvoll, allerdings sollte man es niemals mit HTML-Kommentaren machen, wenn es sich um ein PHP-Script handelt!

2 Nachteile
HTML-Kommentare haben zwei Nachteile: Zuerst einmal blähen sie den zum Client zu übertragenden Code unnötig auf. Den Besucher interessiert der einer Webseite zugrunde liegende HTML-Code nicht. Er möchte, dass die Seite benutzbar, übersichtlich, hübsch usw. ist – warum der Browser die Seite so anzeigt, ist dem Besucher völlig egal. Deshalb gucken sich auch die wenigsten Nicht-Entwickler den Quelltext einer Seite an.
HTML-Kommentare ändern nun aber nichts an der Darstellung der Seite im Browser des Nutzers. Er ärgert sich nur, wenn die Übertragung der Webseite länger dauert.
Die einzige Ausnahme, wann HTML-Kommentare die Darstellung verändern, sind Conditional Coments und Server Side Includes (wobei letztere heute wohl kaum noch genutzt werden). Diese Kommentare sind natürlich nicht unnötig und dürfen natürlich drin bleiben. Alle anderen sollten entfernt bzw. ersetzt werden.

Der zweite Nachteil, wenn man einfach nicht mehr benötigte Code-Teile drin lässt, sind eventuelle Sicherheitsbedenken. Wenn man ganze Form-Elemente beispielsweise auskommentiert, sollte man sich nicht wundern, wenn auf einmal dieses Formular doch benutzt wird und eventuell schadhafter Code eingeschleust wird. Ein Angreifer muss sich die Webseite ja nur lokal speichern, die Kommentare entfernen und hat dann freie Hand.

Sinnvoller Ersatz
Wie oben bereits gesagt, sind Kommentare ja sehr sinnvoll. Da sie nur für Entwickler interessant sind, können sie auch ausschließlich serverseitig verwendet werden – also als PHP-Kommentare. Und dort stört es auch nicht, wenn innerhalb des Kommentars der HTML-Code enthalten ist.

<body> Sichtbarer Text <?php /* ?> Kommentar-Text, gern auch <b>mit HTML-Tags</b> <?php */ ?> </body>

Übrigens fügen auch viele externe Dienste HTML-Kommentare ein. Zum Beispiel enthält der HTML-Code zur Einbindung des Ebay Relevance Ads (ein Werbemittel des Ebay-Partnerprogramms) HTML-Kommentare:

<!-- eBay RelevanceAd --> <script language='JavaScript' type='text/javascript'> //<-- DO NOT CHANGE --> ... </script> <!-- /eBay RelevanceAd -->

Diese HTML-Kommentare sind völlig unnötig und allein darin begründet, dass ein unbedarfter Webmaster aus Versehen Teile des Codes löscht, weil er nicht weiß, worum es sich dabei handelt. Aber auf Webseiten von richtigen Entwicklern (im Gegensatz zu Privatleuten, die manchmal nicht ganz wissen, was sie tun) haben diese Kommentare nichts zu suchen. Hinzu kommt noch, dass der sinnfreie JavaScript-Kommentar „DO NOT CHANGE“ ebenfalls gelöscht werden sollte.

Welche Meinung habt ihr zu HTML-Kommentaren? Braucht man sie? Welche Einsatzgebiete habt ihr dafür?