quakenet:#php Tutorial

1. Was sind Kommentare?

Streng genommen sind Kommentare in PHP-Dateien Texte, die vom PHP-Interpreter nicht beachtet werden. Sie werden beim Parsen der Datei übersprungen. Nur was bringen dann solche Textstellen?

In Textstellen, die als Kommentare gekennzeichnet sind, können wir alles reinschreiben. Wir können da z.B. Notizen über das Script reinschreiben. Aber es ist auch üblich, so genannte Kopfdaten für das Script zu verfassen wie z.B. Name des Autors oder eine kurze Beschreibung des Scriptes.

2. Welche Kommentare gibt es?

Es gibt 2 Arten von Kommentaren. Einmal gibt es mehrzeilige Kommentare und dann gibt es einzeilige Kommentare. Ein einzeiliger Kommentar wird mit // eingeleitet und endet am Ende der Zeile.

<?php
    // Ein Beispielkommentar

    echo "Hallo Welt!"; // gibt folgendes aus: Hallo Welt!

    echo "Ein String mit //, aber das hier ist kein Kommentar";

    // Ende der Datei
?>

Dies sind Beispiele für Kommentare. Nach den // kann man beliebigen Text hinzufügen. Ein einzeiliger Kommentar gilt, wie es der Name schon sagt, nur in einer Zeile. Das heißt, von // bis zum Zeilenende. Im String des 2. echo-Befehls ist ein // vorhanden, doch diese Zeichen werden nicht als Kommentare interpretiert, da sie in einem String stehen. Diese beiden Zeichen werden dann ganz normal an den Browser geschickt.

Wenn man einen etwas längeren Kommentar bzw. eine etwas längere Notiz schreiben möchte, benutzt man den mehrzeiligen Kommentar. Dieser wird mit einem /* eingeleitet und endet mit einem */.

<?php
    /*
        Dies ist ein Hello World Script. Damit
        kann man testen ob PHP auf dem Server
        installiert und aktiviert ist.

        Author: Progman
    */

    echo "Hallo Welt!"; // gibt folgendes aus: Hallo Welt!

    /*
        Copyright @ Progman
    */
?>

Wie man sieht, kann man einzeilige und mehrzeilige Kommentare in einem Skript kombinieren. Innerhalb von /* und */ kann jeder beliebiger Text stehen. Wenn man aber innerhalb von /* und */ noch ein */ schreibt, denkt PHP, dass dann an dieser Stelle der Kommentar zu Ende sei. Dies passiert oft beim Auskommentieren großer Programmblöcke.

3. Auskommentieren

Auskommentieren ist der Fachbegriff, wenn man einen einzelnen Befehl in einen einzeiligen Kommentar oder mehrere Befehle in einen mehrzeiligen Kommentar packt. Dies macht man, wenn man einen Fehler suchen möchte und man nicht möchte, dass diverse Programmteile ausgeführt werden.

<?php
    echo "Hallo Welt\n";
    //echo "<br />";
    echo "Und wieder hi";
?>

Hier wurde zum Beispiel der Befehl echo "<br />"; auskommentiert. Hier wurde nur ein einziger Befehl auskommentiert. Mit dem mehrzeiligen Kommentar kann man mehrere Befehle 'deaktivieren'.

<?php

    befehl1();
    /*
    befehl2();
    befehl3();
    befehl4();
    */
    befehl5();
?>

Die Befehle 1 und 5 werden ausgeführt. Die Befehle 2-4 wurden auskommentiert. Beim Auskommentieren von mehreren Befehlen muss man aufpassen, dass man keine mehrzeilige Kommentare auskommentiert.

<?php

    befehl1(); // wird aufgerufen
    /*
    befehl2(); // wird nicht aufgerufen
    /*
    befehl3(); // wird auch nicht aufgerufen
    befehl4(); // und das hier auch nicht
    */         // Hier endet aber der Mehrzeilige Kommentar
    befehl5(); // dieser Befehl wird ausgeführt
    */         // Hier wird der PHP-Interpreter meckern
               // das hier unerwartet das Schlusszeichen
               // für ein mehrzeiligen Kommentar kommt
    befehl6(); // Dieser Befehl würde ausgeführt werden
               // Doch der PHP-Interpreter scheitert schon an
               // dem */ vorhin, was er nicht verarbeiten kann
?>

Dies kann ganz schnell bei großen Scripten passieren. Man hat gestern ein kleinen Teil auskommentiert und heute kommentiert man einen noch größeren Teil aus und hat an den inneren, mehrzeiligen Kommentar nicht mehr gedacht.

Fragen zum aktuellen Thema

1. Welche Kommentare gibt es?

Welche Kommentare gibt es?

Es gibt 2 Arten von Kommentaren

• Einzeilige Kommentare - eingeleitet durch //.

• Mehrzeilige Kommentare - eingeleitet durch /* und endet mit */.