PHP Kommentare: Kommentieren, Strukturieren, Debuggen
Wie du in PHP Kommentare sinnvoll einsetzt, um deinen PHP-Code für dich selbst und andere besser verständlich zu halten.Tags: Debuggen | HTML lernen | HTML5 | Kommentare | PHP lernen | Struktur | Visual Studio Code | Web-Development lernen | Webseiten erstellen lernenWorum geht´s?
Wie auch in den meisten anderen Programmiersprachen gibt es auch in PHP Kommentare. In diesem Tutorial wirst du die zwei Arten von Kommentaren in PHP kennen lernen, und wie du Kommentare am besten einsetzt, um deinen PHP-Code übersichtlicher zu halten.
1. Die zwei Arten der PHP Kommentare: zeilenweise und von-bis
Die Skript-Sprache PHP bietet dir zwei Möglichkeiten, Kommentare in deinen PHP-Code einzubauen.
Diese werden wir uns nun kurz ansehen:
1.1 Zeilenweise Kommentare in PHP
Mit Hilfe von zwei Schrägstrichen (//) kannst du deinem PHP-Skript anzeigen, dass alles rechts davon als Kommentar zu werten ist.
Das bedeutet, dass der PHP-Interpreter (das Programm, das deinen PHP-Code als „Anleitung“ nimmt, um die Anweisungen umzusetzen) alles rechts dieser beiden Schrägstriche ignoriert:
<?php echo "Hallihallo!"; // gib Hallihallo! aus ?>
1.2 Von-bis Kommentare in PHP
Wenn du mehrere Zeilen auf einmal zu einem Kommentar machen willst (oder nur einen Teil einer Zeile), kannst du alternativ zu dein zeilenweisen Kommentaren in PHP auch von-bis Kommentare setzen.
Der Kommentar startet dann mit einem /* und endet mit einem umgekehrten */.
Alles zwischen diesen beiden Markierungen wird vom PHP-Interpreter als Kommentar behandelt, das heißt ignoriert.
Im folgenden Fall wurde z.B. die FOR-Schleife „auskommentiert“, das heißt zu einem Kommentar gemacht.
<?php echo "Hallihallo!"; // gib Hallihallo! aus /*for ($i = 1; $i <= 10; $i++) { echo "<a href='seite".$i.".php'>Link ".$i."</a><br>"; }*/ ?>
1.3 Achtung: PHP Kommentare dürfen nur im PHP-Code-Teil vorkommen!
PHP Kommentare funktionieren nur innerhalb der PHP-Tags („<?php“ und „?>“).
Willst du innerhalb einer .php-Datei dort wo du außerhalb der PHP-Tags irgendetwas zu einem Kommentar machen, brauchst du die HTML-Kommentare:
<!DOCTYPE html> <html lang="en"> <head> <!-- hier braucht es einen HTML-Kommentar, PHP-Kommentare würden hier nicht funktionieren!! --> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> <link rel="stylesheet" href="style.css"> </head> <body> <h1>Überschrift 1</h1> <?php // das ist ein funktionierender PHP-Kommentar for ($i = 1; $i <= 10; $i++) { echo "<a href='seite".$i.".php'>Link ".$i."</a><br>"; } ?> </body> </html>
Üblicherweise werden sowohl HTML-Kommentare als auch PHP-Kommentare in Programmier-Umgebungen in bestimmten Farben angezeigt. In Visual Studio Code üblicherweise in grün:
2. Warum Kommentare Sinn machen: 3 häufige Einsatzmöglichkeiten
Warum verwendet man überhaupt Kommentare beim Programmieren?
Der Hauptgrund ist, um zu einem späteren Zeitpunkt noch überblicken zu können, was man sich damals beim Programmieren gedacht hat.
Dies kann wichtig sein, falls man im Team mit anderen arbeitet, oder falls jemand anderer später auf dem eigenen Code aufbauen möchte und den daher auch verstehen muss.
Was gerade Programmier-Anfänger am Anfang sehr seltsam vorkommen wird, ist aber auch wichtig: damit man auch selber wieder rausfinden kann, was man sich damals gedacht hat.
Es ist echt unglaublich, wie wenig lange es dauert, bis man die Hälfte seines selbst geschriebenen Programmier-Codes selbst nicht mehr kapiert. Wenn das Programm etwas komplizierter wird, kann diese „Halbwertszeit“ auch schonmal auf einige Studen sinken.
Um da etwas gegenzuarbeiten, sind Kommentare sehr, sehr hilfreich.
Vor allem helfen sie dir in 3 Varianten:
- Beschreibung
- Strukturierung
- Debuggen (Fehlersuche)
2.1 Vorteile von PHP Kommentaren 1: Beschreibung
Diese Variante, Kommentare einzusetzen, ist für viele vermutlich die offensichtlichste: Man schreibt direkt im Code dazu, was man sich beim Programmieren gedacht hat.
Das Ganze sollte jetzt aber auch nicht in einen Roman ausarten. Eine Teilnehmerin eines Programmier-Kurses hat das dann „etwas“ übertrieben, und für ein Programm mit ca. 200 Zeilen in etwa 600 Zeilen Kommentare als Beschreibung dazugeschrieben.
Eine Faustregel für Kommentare in PHP könnte lauten: So viel wie notwendig, so wenig wie möglich.
2.2 Vorteile von PHP Kommentaren 2: Strukturierung
Wenn ein Programmcode etwas umfangreicher wird, besteht dieser meist aus mehreren logisch zusammengehörenden Blöcken.
Kommentare können in PHP auch verwendet werden, um gewissermaßen „Kapitel-Überschriften“ in den PHP-Code einzufügen.
Weil Kommentare in den meisten Entwicklungs-Umgebungen eine deutlich sichtbare andere Farbe haben, kann man so recht gut über den gesamten Code scannen, um bestimmte Funktionen wiederzufinden.
Wenn du z.B. Visual Studio Code als Entwicklungsumgebung benutzt, gibt es auch eine Erweiterung, die auch noch verschiedene Farben für Kommentare ermöglicht. Das ermöglich noch weitere Gestaltungsmöglichkeiten. Mehr dazu im entsprechenden Tutorial über Visual Studio Code.
2.3 Vorteile von PHP Kommentaren 3: Auskommentieren beim Debuggen (Fehlersuche)
Wenn dein PHP-Code erst einmal über ein paar wenige Zeilen hinausgeht, wirst du früher oder später die ersten Fehler beim Programmieren machen.
Manche Fehler werden dir gleich in der Entwicklungsumgebung angezeigt. Das sind die vergleichsweise einfachen Fehler.
Schwieriger sind die zu finden, die zwar das Programm nicht zum Abstürzen bringen, aber trotzdem etwas falsch machen.
Wenn du /* und */ verwendest, um einen Teil deines Programms auszukommentieren (= zum Kommentar machen), kannst du manchmal schneller herausfinden, in welchem Bereich deines Programms sich der Fehler vermutlich befindet.
Das wars auch schon wieder zu Kommentaren in PHP 🙂