Websiteentwicklung: PHP: Kommentare
Aus Wikibooks
Innerhalb eines Scriptes ist es möglich Notizen zu schreiben, ohne dass der PHP-Parser versucht diese als PHP-Anweisungen zu interpretieren. Solche Textpassagen nennt man Kommentare.
In PHP gibt es 3 Arten von Kommentaren:
Inhaltsverzeichnis |
[Bearbeiten] Einzeilige Kommentare
Einzeilige Kommentare sind Kommentare die nur in einer einzigen Zeile gültig sind bzw. bis zum Ende der Zeile reichen. Sie werden mit // eingeleitet. Oder alternativ, aber seltener gebraucht, mit Hilfe von #. Alles was in der gleichen Zeile im Anschluss folgt wird vom PHP-Parser ignoriert. Beispiel
<?php // Einen Text ausgeben echo 'foobar'; # Einen zweiten Text ausgeben echo 'bla'; // "bla" ausgeben ?>
[Bearbeiten] Mehrzeilige Kommentare
Wie der Name schon vermuten lässt, verlaufen mehrzeilige Kommentare über mehrere Zeilen im Script. Ähnlich wie in XHTML gibt es ein "Startzeichen" für ein mehrzeiligen Kommentar und ein "Schlusszeichen". In PHP sind es die Textbausteine /* (Anfang) und */ (Ende). Das Beispiel zeigt, wie man diesen Kommentartyp verwendet.
<?php /* Dies ist ein mehrzeiliger Kommentar, der etwas beschreibt. */ echo 'foobar'; /* Ein mehrzeiliger Kommentar in nur einer Zeile */ echo 'bar'; ?>
[Bearbeiten] PHPDoc-Kommentare
Neben den normalen ein- und mehrzeiligen Kommentaren gibt es auch noch die PHPDoc Kommentare. Diese werden genutzt um Dokumentation zu erzeugen und werden statt mit /* mit /** gestartet und haben in jeder neuen Zeile einen Stern. Diese Art der Kommentare braucht dich im Moment noch nicht zu interessieren, da diese oft nur bei objektorientiertem Code benutzt werden.
[Bearbeiten] Auskommentieren
Mit Hilfe der Kommentare ist es möglich einzelne Anweisungen oder ganze Anweisungsgruppen von der Ausführung durch den PHP-Interpreter auszunehmen, ohne sie aus dem Script zu löschen. Dazu schreibt man entweder // vor die Zeile oder packt alle Anweisungen in ein mehrzeiligen Kommentar.
<?php echo 'erste Zeile'; //echo 'zweite Zeile'; echo 'dritte Zeile'; /* vom Autor vorläufig deaktiviert echo 'foo'; echo 'bar'; */ ?>
Das Auskommentieren von einzelnen Zeilen oder ganzen Abschnitten wird häufig bei der Fehlersuche verwendet. So kann man beispielsweise Funktionen oder ganze Programmabschnitte von denen man vermutet, dass sie einen Fehler verursachen, als Kommentar kennzeichnen. Führt man das Script nun erneut aus und der Fehler tritt nicht mehr auf, so weiß man dass der Fehler in der Funktion bzw. in diesem Programmabschnitt gewesen sein muss. Damit ist es für den Programmierer leicht möglich, den fehlerhaften Bereich zu lokalisieren.
