PHP: Was sind Kommentare und wie werden sie verwendet?

Von Veröffentlicht am

Kommentare in PHP sind Notizen im Code, die das Programm ignoriert und Menschen lesen. Sie erklären, warum eine Stelle so gelöst ist – das ist genau die Information, die sechs Monate später fehlt. Dieses Tutorial zeigt die drei Schreibweisen und wann welche passt.

Kommentare helfen Ihnen selbst, wenn Sie ein altes Skript wieder öffnen. Sie helfen anderen, die Ihren Code übernehmen. Und sie helfen beim Lernen: Wer in eigenen Worten neben eine Zeile schreibt, was sie tut, merkt sofort, ob er sie verstanden hat.

Grundlagen der Kommentare in PHP

PHP kennt drei Schreibweisen. Die Grafik zeigt alle drei in einem kleinen Skript:

Die drei Kommentararten in PHP farbig markiert: Dokumentationsblock über einer Funktion, einzeiliger Kommentar mit zwei Schrägstrichen oder Raute und mehrzeiliger Kommentar zwischen Schrägstrich-Stern und Stern-Schrägstrich

  • Einzeilig: Zwei Schrägstriche // oder eine Raute #. Alles bis zum Zeilenende ist Kommentar.
  • Mehrzeilig: Beginnt mit /* und endet mit */. Dazwischen dürfen beliebig viele Zeilen stehen.
  • Dokumentationsblock: Beginnt mit /**. Er steht über Funktionen und Klassen und wird von Editoren ausgewertet.
<?php
// Einzeiliger Kommentar
# Ebenfalls einzeilig, seltener genutzt

/*
   Mehrzeiliger Kommentar:
   Hier ist Platz für längere Erklärungen.
*/

$preis = 100; // Kommentar am Zeilenende
?>

Gute Kommentare erklären das Warum

Ein Kommentar, der nur wiederholt, was im Code steht, ist überflüssig. Wertvoll ist, was man dem Code nicht ansieht: der Grund für eine Entscheidung.

<?php
// Schlecht: wiederholt nur den Code
$i = $i + 1; // i um eins erhöhen

// Gut: erklärt den Grund
$frist = 14; // Widerrufsfrist laut Gesetz in Tagen
?>

Faustregeln für gute Kommentare in PHP:

  • Schreiben Sie das Warum, nicht das Was.
  • Halten Sie Kommentare kurz und konkret.
  • Ändern Sie den Kommentar mit, wenn Sie den Code ändern. Ein veralteter Kommentar ist schlimmer als keiner.
  • Gute Namen ersetzen viele Kommentare. $nettoPreis braucht keine Erklärung, $x schon.

Funktionen dokumentieren mit DocBlocks

Über eine Funktion gehört ein Dokumentationsblock. Er nennt die Aufgabe, die Parameter und den Rückgabewert. Editoren wie Visual Studio Code oder PHPStorm zeigen diesen Text an, sobald Sie die Funktion irgendwo aufrufen.

<?php
/**
 * Berechnet den Bruttopreis aus einem Nettopreis.
 *
 * @param float $netto Preis ohne Mehrwertsteuer
 * @param float $satz  Steuersatz, zum Beispiel 0.19
 * @return float Preis inklusive Steuer
 */
function brutto($netto, $satz = 0.19) {
    return $netto * (1 + $satz);
}
?>

Die Angaben mit @ folgen einem verbreiteten Standard namens PHPDoc. Werkzeuge können daraus sogar eine fertige Dokumentation als Webseite erzeugen.

Kommentare bei der Fehlersuche

Funktioniert ein Skript nicht, können Sie verdächtige Zeilen vorübergehend auskommentieren, statt sie zu löschen. Läuft das Skript danach, wissen Sie, wo der Fehler steckt.

<?php
$summe = 10 + 5;
// $summe = $summe * $faktor;   vorübergehend deaktiviert
echo $summe;
?>

Wichtig ist, solche Reste vor dem Veröffentlichen aufzuräumen. Auskommentierter Code verwirrt später mehr, als er hilft. Die alte Fassung bewahrt besser eine Versionsverwaltung wie Git auf.

Kommentare in PHP im Alltag einsetzen

Nützlich sind Kommentare dort, wo der Code das Was schon zeigt, aber nicht das Warum: bei einer ungewöhnlichen Bedingung, einer bewussten Ausnahme oder einer Zahl, die aus einer fachlichen Vorgabe stammt. Was im Code selbst steht, muss nicht wiederholt werden.

Beachten Sie den Unterschied zu HTML-Kommentaren der Form <!-- … -->. Diese landen im Quelltext der Seite und kann jeder Besucher lesen. Kommentare in PHP bleiben dagegen auf dem Server. Interne Hinweise gehören deshalb immer in PHP-Kommentare.

Typische Fehler mit Kommentaren

  • Verschachtelte Blockkommentare: Ein /* … */ innerhalb eines anderen funktioniert nicht. Das erste */ beendet den Kommentar, der Rest erzeugt einen Syntaxfehler.
  • Schließendes PHP-Tag im einzeiligen Kommentar: Steht ?> hinter //, endet trotzdem der PHP-Bereich. Alles danach wird als HTML ausgegeben.
  • Vergessenes Ende: Fehlt das */, wird der ganze restliche Code zum Kommentar. Ein Editor mit Farben zeigt das sofort.

Häufige Fragen zu Kommentaren in PHP

Welche Schreibweisen gibt es?

Zwei Schrägstriche und die Raute für eine Zeile, Schrägstrich-Stern für mehrere Zeilen und Schrägstrich mit zwei Sternen für Dokumentationsblöcke.

Werden Kommentare an den Browser gesendet?

Nein, PHP-Kommentare bleiben auf dem Server. HTML-Kommentare dagegen sind im Quelltext sichtbar.

Wie dokumentiere ich eine Funktion?

Mit einem Block-Kommentar direkt darüber, der Parameter und Rückgabewert benennt.

Kosten Kommentare Rechenzeit?

Praktisch nicht; der Interpreter überliest sie.

Jetzt eigene Funktionen schreiben – dort zahlt sich saubere Dokumentation direkt aus. Ebenfalls hilfreich sind Typen in PHP und IF-Anweisungen.