Kommentare

Innerhalb der Programmcodes sollten immer Kommentare geschrieben werden. Diese sind nicht nur für einen selbst, sondern auch für anderer Programmierer. Kommentare werden programmtechnisch nicht ausgeführt.

Einzeiliger Kommentar

Dieser kann entweder als eigene Zeile geschrieben werden, oder auch hinter einer Programmzeile gehangen werden. Er beginnt mit zwei Slashes "//".

<?PHP

$meinAlter 
28//  Kommentar:  Mein  Alter

//  Kommentar:  Der  Text  zum  Alter
$meinText  'Alter  in  Jahre';

?>

Mehrzeiliger Kommentar

Falls mehrere Zeilen benötigt werden, beginnt der Kommentar mir "/*" und endet mit "*/". Der gesamte Kommentarebereich sollte in eigenen Zeilen stehen (wegen der Übersicht).

<?PHP

/*  Mein  Programm
    Dieses  Programm  erstellt  eine  Variabel  mit  meinem  Alter.
    Mehr  nicht.
*/

$meinAlter  38;

?>

Er kann allerdings auch Einzeilig genutzt werden.

<?PHP

/*  Text  für  die  Frage  */
$meinText  'Warum  nur?';

?>

Schöner Kommentar

Um es lesbarer zu halten, achten viele auf die Form, Abstände und Ebenen. Jeder Programmierer entwickelt einen eigenen Stil. In vielen Programmiersprachen sind aber Konventionen erstellt worden, wie der Kommentar auszusehen hat. Dies hat aber auch praktische Gründe. So wird zum Beispiel in Java dann eine automatische HTML-Dokumentation erstellt (javadoc).

<?PHP

/*  Überschrift
  *
  *  Hier  steht  Text  der  keinen  Bezug  zum  Programm  hat.
  *  Hier  steht  Text  der  keinen  Bezug  zum  Programm  hat.
  */

//  -------------------------------
//  Überschrift
//  -------------------------------
//  Hier  steht  Text  der  keinen  Bezug  zum  Programm  hat.

?>