In diesem Artikel aus dem PHP Tutorial möchte ich Dir zeigen, wie Du Kommentare in PHP dazu verwenden kannst, deinen eigenen Code verständlicher zu machen.

Egal ob Du nun mit anderen Entwicklern zusammenarbeitest oder nach einiger Zeit Änderungen an deinem Code vornehmen möchtest, komplexere Projekte bedürfen sinnvollen Kommentaren, um verstanden zu werden.

Da du jetzt bereits weißt, was PHP ist und wie Du PHP-Dateien erstellen kannst, werde ich Dich hier kurz über die Kommentare in PHP aufklären.

Besonderheiten eines Kommentars

Kommentare werden von dem PHP Intepreter komplett ignoriert, das heißt, es spielt für die Leistung Deines Skriptes keine Rolle, wie viele Kommentarzeilen die Datei enthält.

Dementsprechend können Inhalte innerhalb von Kommentaren, sofern Du sie denn richtig setzt, nicht für Fehler auf der Seite verantwortlich sein.

Einzeilige Kommentare

In PHP unterscheidet man zwischen ein- und mehrzeiligen Kommentaren. Ein einzeiliger Kommentar endet immer mit dem Zeilenende und beginnt mit //.

Es ist sinnvoll ihn zum Beispiel einzusetzen, um zu erklären, wofür eine Variable benötigt wird, oder was passiert, wenn eine if-Abfrage ausgeführt wurde.

Hier ein kurzes Beispiel für einen Kommentar:

<?php
// Gibt 'Hallo Welt' aus
echo 'Hallo Welt!';
?>

Mehrzeiliger Kommentar

Um ausführliche Erläuterungen in dein Skript einzubinden, etwa zu Beginn einer PHP-Datei, kannst Du mehrzeilige Kommentare verwenden.

Da diese, wie es der Name offenbart, nicht nur auf eine Zeile beschränkt werden, muss sowohl das Ende als auch der Anfang markiert werden.

Ein solcher Kommentar wird mit /* eingeleitet und endet mit */. Das verdeutlicht dieses Beispiel:

<?php
/* Dies ist ein Kommentar,
der über mehrere Zeilen geht. */
?>

Es hat sich übrigens so eingebürgert, in jede Kommentar-Zeile ein * zu setzen, auch wenn dies aus technischer Sicht nicht notwendig ist:

<?php
/*
* 1. Kommentarzeile
* 2. Kommentarzeile
* 3. Kommentarzeile
*/
?>

Fazit und Ausblick

Du weißt jetzt, was ein- und mehrzeilige Kommentare in PHP sind, das ist wichtig, um von Beginn an ein Projekt gut zu dokumentieren.

In dem nächsten Teil der Tutorial-Serie erkläre ich Dir dann, was if-Abfragen und Variablen sind.