PHP 4.3

2.2 Einfügen von Kommentaren

Zu einem übersichtlichen Programmierstil gehören in allen Programmiersprachen unter anderem (z.B. Einrückungen) auch die Kommentare. Gerade Anfänger verzichten leider sehr oft auf eine Kommentierung, was sehr schnell zu einer Unverständlichkeit des geschriebenen Programms führt. Wer dann nach längerer Zeit Änderungen in seinem Programm vornehmen möchte, wird schnell feststellen, dass er sich nicht mehr daran erinnern kann, was er an den entsprechenden Stellen in seinem Programmcode beabsichtigt hat. Besonders bei der erstmaligen Benutzung von Variablen raten wir dazu, sich einen Kommentar zu der jeweiligen Variablen in Bezug auf Funktion und Bedeutung als Kommentar dazuzuschreiben. Auf diese Weise können Sie auch später noch rekonstruieren, was die jeweilige Variable für eine Aufgabe hat. Außerdem können sich auf diese Art und Weise auch andere an diesem Projekt mitarbeitende Programmierer wesentlich schneller in den erstellten Code einarbeiten.

Die im PHP-Programmtext eingestreuten Kommentare werden von PHP ignoriert und somit auch nicht an den Browser weitergegeben. Damit können Sie beliebig viele Kommentare einbinden, denn auf die Größe der übertragenen Seite haben sie keinen Einfluss. Je genauer Sie Ihren Programmcode mit Kommentaren versehen, umso leichter fällt Ihnen der Überblick!

Im Folgenden möchten wir Ihnen die verschiedenen Formen der Kommentierung von PHP vorstellen:

Zum Kommentieren von nur einer Zeile (C++ -Stil):

<?php
  // Hier steht der Kommentar
  echo "Hallo Du";
?>

Die Kommentare mit // bieten sich an, wenn Sie jeweils einen kurzen Kommentar in nur einer Zeile einfügen wollen.

Mehrzeiliges Kommentieren wird folgendermaßen realisiert (C-Stil):

<?php

  /*
  Hier steht der mehrzeilige Kommentar.
  Dieser wird von PHP ignoriert und taucht
  auch nicht im Browser auf.
  echo "Hallo Sie";
  */

  echo "Hallo Du";
?>  

Mit Hilfe der Symbole /* .... */ haben Sie die Möglichkeit, Kommentare mit mehreren Zeilen in Ihren Code einzubinden, ohne am Anfang jeder Zeile ein Symbol für einen einzeiligen Kommentar einfügen zu müssen.

Als Browserausgabe erhalten wir in diesem Beispiel nur einmal die Ausgabe Hallo Du, weil sich die obere echo-Anweisung innerhalb des Kommentars befindet und somit nicht als auszuführender Quellcode gedeutet wird.

Browserausgabe für alle oben genannten Beispiele:

Hallo Du

Beachten Sie: Egal für welche Art von Auskommentierung Sie sich entscheiden, die Anmerkung wird immer im Quelltext verborgen bleiben und nie für den Endbetrachter auf der jeweiligen Seite zu sehen sein.

Kommentare (0)

Ihr Kommentar

Name