Websiteentwicklung: PHP: Kommentare

Websiteentwicklung PHP Kommentare

Kommentare sind Teile eines PHP-Skriptes, die vom PHP-Parser ignoriert und daher nicht ausgeführt werden. Somit ist es möglich, Anmerkungen und Notizen zu einem Skript und Erläuterungen zum Code hinzuzufügen. Die Lesbarkeit des Codes wird dadurch erhöht, sowohl für andere Personen als auch für den Autor selbst.

In PHP gibt es verschiedene Arten von Kommentaren: einzeilige, mehrzeilige und PHPDoc-Kommentare.

Einzeilige Kommentare

Einzeilige Kommentare reichen nur bis zum Ende der Zeile. Sie werden mit // eingeleitet. Alternativ, aber seltener gebraucht, mit Hilfe von #. Alles was in der gleichen Zeile im Anschluss folgt wird vom PHP-Parser ignoriert. Beispiel:

<?php
// dieses hier wird nicht beachtet,
echo 'foobar';

# dieses auch nicht
echo 'bla'; // auch dieser Teil nicht
?>

Mehrzeilige Kommentare

Mehrzeilige Kommentare können über mehrere Zeilen verlaufen - und zwar so lange, bis sie beendet werden. Ähnlich wie in XHTML gibt es für einen mehrzeiligen Kommentar eine "Startsquenz" und eine "Schlusssequenz". Ein mehrzeiliger Kommentar beginnt mit /* und geht bis zum nächsten */.

<?php
/* Dies ist ein mehrzeiliger
   Kommentar, der etwas beschreibt. */
echo 'foobar';

/* Ein mehrzeiliger Kommentar in nur einer Zeile */
echo 'bar';
?>

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.

 <?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 vorhanden sein muss. Damit ist es für den Programmierer leicht möglich, den fehlerhaften Bereich zu lokalisieren.

PHPDoc-Kommentare

PHPDoc-Kommentare können dazu genutzt werden, die Erstellung einer Dokumentation zu vereinfachen. Gestartet werden sie mit /**, jede neue Zeile wird durch einen Stern eingeleitet. Beendet werden sie mit */. Diese Art der Kommentare braucht dich im Moment noch nicht zu interessieren, da diese oft nur bei komplexerem und umfangreicherem Code benutzt werden.

Beispiel:

 <?php
/**
 * Datei mit PHPDoc-Testkommentar
 *
 * @package test
 * @author ich
 * @version 0.1
 * @copyright keins
 */ 
echo 'erste Zeile';
 ?>

Zurück zu Ausgabe | Hoch zu PHP | Vor zu Variablen