HTML, PHP und CSS Kommentare, bzw. einzelne Codes deaktivieren

In HTML, PHP wie auch in CSS gibt es die Möglichkeit Kommentare einzufügen, die auf der Webseite selbst nicht zu sehen sind. Solche Kommentare ermöglichen dem Betreiber bzw. Webdesigner seine Codes zu strukturieren. Die Kommentarfunktion in HTML, PHP und CSS setzt gleichzeitig auch einzelne Codes außer Gefecht, d.h. die in den Kommentar Code gesetzten Codes werden nicht mehr ausgeführt. So sind Kommentare neben der Strukturierung auch dafür geeignet entsprechenden Code zu deaktivieren.

Ich persönlich verwende am liebsten PHP Kommentare. Zum einen um bestimmte Bereiche voneinander abzugrenzen, so dass es mir später auch möglich ist diese auf die Schnelle zu identifizieren. Auch wenn ich vorübergehend Bereiche meiner Codes deaktivieren möchte, verwende ich die PHP Kommentarfunktion, so dass ich sie erst einmal nicht löschen muss und später ganz einfach wieder aktivieren kann.

Natürlich könnte ich auch HTML Kommentare dafür verwenden. Diese haben aber den Nachteil, dass sie im Quellcode der Seite erscheinen. Sie verwenden so zum einen Speicherplatz, werden bei jedem Seitenaufruf mit generiert und sind für jeden zu lesen und zu sehen, der sich den Quellcode vor Augen führt.

HTML Kommentare

HTML Kommentare sind daran zu erkennen, dass Sie mit <!-- beginnen und mit --> enden. Alles was zwischen diesen beiden Codes steht, wird als Kommentar behandelt, z.B.:

<!-- Ich bin ein Kommentar -->

Steht anstatt dem Text eine HTML Codezeile, wie z.B.

<!-- <div class="klasse">Hallo meine Kollegen</div> -->

hat das zur Folge, dass dieser HTML Code Bereich deaktiviert wird und wie ein Kommentar behandelt wird.

Will ich auf einer Seite nach HTML Kommentaren suchen, dann öffne ich ganz einfach den Quelltext, und nutze die Suchfunktion mit folgendem String: <!--

PHP Kommentare

Ich nutze bevorzugt PHP Kommentare. Der Code für einen PHP Kommentar ist ganz einfach // vor der entsprechenden Zeile. Also z.B.

// Ich bin ein Kommentar

Vorteil hier ist, dass der Kommentar nur in der PHP Datei zu lesen ist und nicht im Quelltext der Seite erscheint. Auch deaktiviert die Kommentarfunktion gleichzeitig einen Code. Will ich also einen PHP Code deaktivieren, setze ich auch ganz einfach nur // vor die entsprechenden Zeilen.

Ein Mix aus PHP und HTML – Kommentare verwenden

Wer nun aber z.B. wie WordPress Blogger in ihren Themes PHP und HTML gemeinsam verwendet, muss darauf achten, dass für die Kommentarfunktion entsprechend HTML oder PHP aktiviert ist. Wenn ich z.B. gerade im HTML Modus arbeite, sorgt das Einfügen von // dafür, dass diese beiden Zeichen als Text interpretiert werden und auf der Webseite erscheinen. Andersherum im PHP Modus führt <!-- zu einem Parse error. Wer also PHP und HTML in seinen Dateien verwendet, muss erst einmal prüfen, in welchem Modus er sich gerade befindet. PHP wird mit <?php begonnen und mit ?> beendet. Alles was sich dazwischen befindet ist PHP. Davor und danach ist der HTML Modus aktiv.

Möchte ich nun z.B. im HTML Modus einen PHP Kommentar einfügen, sieht das z.B. so aus:

<?php //Ich bin ein Kommentar ?>

Wenn ich andersrum im PHP Modus einen HTML Kommentar einfügen möchte, dann muss ich erst PHP beenden, dann meinen HTML Kommentar einfügen und danach wieder PHP beginnen, z.B:

<?php mein code ?>
<-- Mein HTML Kommentar -->
<?php weiterer PHP Code...

PHP Code deaktivieren

Beim Deaktivieren des PHP Codes ist es wichtig, dass vor jeder Zeile die beiden Striche stehen, sonst wird immer nur die entsprechende Zeile deaktiviert und nicht der ganze Code, wenn er aus mehreren Zeilen besteht, z.B.:

<?php //Codezeile 1
//Codezeile 2
//Codezeile 3 ?>

HTML Kommentar als Robots Anweisung

HTML Kommentare werden in einzelnen Fällen für Robots als Anweisungen genutzt. So sorgt z.B. der HTML Kommentar <!-- google_ad_section_start --> und <!-- google_ad_section_end -->, dass alles, was dazwischen steht, für den Google Adsense Bot als relevant für die Generierung der entsprechenden Anzeigen gilt (Adsense Targeting). In WordPress Themes sollten diese beiden HTML Codes bevorzugt den PHP Code the_content umschließen, also z.B.:

<!-- google_ad_section_start -->
<?php the_content() ?>
<!-- google_ad_section_end -->

CSS Kommentare und Code deaktivieren

Zum Schluß der Vollständigkeit halber noch kurz zu den CSS Kommentaren. In jeder CSS Datei gibt es natürlich auch die Möglichkeit diese mit Kommentaren zu versehen, was auch wirklich Sinn macht, um am Ende nicht vor einem undurchschaubaren Code-Gebrösel zu stehen. CSS Kommentare beginnen mit /* und enden mit */, also z.B.

/* Ich bin ein Kommentar */

Möchte man in der CSS Datei einzelne CSS Codes deaktivieren, so geht das auch ganz einfach, indem der Beginn und das Ende des CSS Kommentarcodes vor und nach den entsprechenden CSS Code gesetzt wird. Ähnlich wie bei HTML Codes, muss dabei nicht darauf geachtet werden, jede Zeile extra auszublenden, sondern es wird immer der gesamte Bereich, der sich innerhalb dieser beiden Codeschnipsel befindet, ausgeblendet.

HTML, PHP und CSS Kommentare in der Praxis

Ich versuche die meisten HTML Kommentare aus meinen Programmierungen fernzuhalten. Natürlich mit Ausnahme der Google Bot Anweisungen für die Adsense Bereiche (Adsense Targeting). Bei WordPress ist das nicht immer so ganz einfach, denn einige Plugin Authoren verwenden mit Vorliebe die HTML Kommentare, um was auch immer in den Quelltext zu schreiben. In meinen Augen haben diese Kommentare dort aber nichts zu suchen. Auch kommt es hin und wieder vor, dass einige findige Plugin Autoren Links in HTML Kommentaren verstecken. Der Anwender und die Leser sehen sie nicht, dafür aber die Suchmaschinen. Daraum halte ich es auch für wichtig, immer mal wieder seinen Quelltext nach Kommentaren zu durchsuchen und zu überprüfen, was sich darin verborgen hält.