HTML Kommentare
Die Dokumentation von Website-Quellen ist langfristig im Hinblick auf die Homepage Pflege unerlässlich. Zwar bietet ein HTML Kommentar die Möglichkeit die Struktur eines Dokuments für spätere Änderungen nachvollziehbar zu dokumentieren, allerdings sollten diese Informationen nicht zu Lasten des Traffics und der Website-Geschwindigkeit gehen.
Einen in einer statischen Internetseite eingebauten HTML Kommentar aus der Seitenquelle zu entfernen ist keine große Sache. Anders als bei dynamischen Websites ist die Zahl der durch solche Internetseiten zur Verfügung gestellten Einzelseiten normalerweise gering und Aktualisierungen sind eher selten. Hierzu benötigt man lediglich einen einfachen Seiteneditor und Grundkenntnisse in HTML. Bei zunehmender Anzahl von Einzelseiten können alle in den Seitenquellen enthaltenen Kommentare – ein „ordentlicher” Webseiten-Editor, der reguläre Ausdrücke unterstützt vorausgesetzt – automatisch und verzeichnisübergreifend entfernt werden.
Hierzu gibt man einfach einen entsprechenden Ausdruck an, welcher Dokumentationspassagen aus allen unterhalb eines Verzeichnisses enthaltenen Dateien durch eine leere Zeichenkette ersetzt und damit aus der Quelle löscht. Allerdings sollte man sicher sein, dass dieser Filterung keine in einen HTML Kommentar eingebetteten JavaScript-Abschnitte zum Opfer fallen. Auch auf der Kommandozeile – unter Linux mit den Kommandozeilen-Tools find und grep – kann eine automatische Löschung erfolgen. Mit dem Ausdruck <!--[^#\[].*--> bleiben beispielsweise alle in der Quelle enthaltenen Server Side Includes (SSI) und Conditional Comments unangetastet.
Während HTML Kommentare bei statischen Internetseiten vor der Veröffentlichung gezielt mit Hilfe lokaler Anwendungen – also oben angesprochenen Kommandozeilen-Filter oder die „Suchen und Ersetzen”-Funktion des HTML-Editors – entfernt werden können, ist bei dynamischen Internetseiten eine vorausschauende Vorgehensweise angebracht. Bei der Erstellung der Templates für CMS-Systeme, Online Shops, Foren oder Blogs, bei denen die Seitenstruktur dynamisch – Anhand der Rahmenvorlagen und den in Datenbanken abgelegten Inhalten durch die serverseitige Software – zusammengestellt wird, ist es ratsam die zur Projektdokumentation benötigten HTML Kommentare nur im Debug-Modus auszuliefern.
Letztlich bieten die im jeweiligen HTML Kommentar enthaltenen Informationen nur den Entwicklern, nicht aber dem Seitenbesucher, wichtige Anhaltspunkte, die bei der Weiterentwicklung und Pflege der Homepage interessant sind. Der normale Seitenbesucher bekommt diese Informationen normalerweise gar nicht zu Gesicht und die Daten werden umsonst an den Webbrowser übertragen. Das kostet Download-Traffic und verlängert die Ladezeit der Internetseite unnötig. Aus diesem Grunde sollte ein Kommentar grundsätzlich in die in den meisten dynamischen Systemen vorgesehenen Debug-Konstrukte verschachtelt werden. Auf diese Art bleibt die Dokumentation an der benötigten Stelle, allerdings wird nur dann ausgeliefert, wenn sich das System im Debug-Modus gefindet – was für ein Produktivsystem ein eher untypisches Szenario darstellen sollte.
Darüber hinaus ist auch eine Cookie-gesteuerte Auslieferung der Kommentare denkbar: Der mit der Website Erstellung betraute Entwickler kann in seiner Browseranwendung ein spezielles Cookie setzen, welches auf dem Webserver abgefragt wird. Enthält das Cookie einen bestimmten Wert, so erfolgt die Auslieferung der Internetseiten mit allen Kommentaren, während die Seiten an alle anderen Besucher ohne diese Informationen ausgeliefert werden. Ein enthaltener HTML Kommentar wird also nur an den Webentwicker ausgeliefert.