Es ist eine gute Praxis, PHP Code mit aussagekräftigen Kommentaren zu versehen, damit man auch noch nach einigen Monaten die Gedankengänge nachvollziehen kann und auch andere nachvollziehen können, wie der Code aufgebaut ist. Es ist viel einfacher einen Kommentar zu lesen als jeweils die einzelnen Zeilen Code zu analysieren.
Kommentare können auch dazu benutzt werden, einen Teil des Codes zeitweise zu deaktivieren. Man spricht dann von „Code auskommentieren“.
Es gibt in PHP drei verschiedene Arten zu kommentieren.
Eine einzelne Zeile kann wie folgt kommentiert werden:
a) Die Zeile beginnt mit zwei Slashes
|
1 |
// hier der Kommentar, der von PHP ignoriert wird |
b) Die Zeile beginnt mit einer Raute
|
1 |
# auch dies ist ein einzeiliger Kommentar, der von PHP nicht ausgelesen wird |
Ein Kommentar kann auch am Ende einer Zeile eingefügt werden, z.B.
|
1 |
$Hauptstadt = 'Berlin'; // diese Variable speichert den Namen der Hauptstadt |
ebenso kann man auch mit der Raute am Ende der Zeile einen Kommentar einfügen:
|
1 |
$Land = 'Deutschland'; # diese Variable speichert den Namens des Landes |
Mehrere Zeilen werden ebenso wie in CSS mit einem /* … */ eingeschlossen
|
1 2 |
/* Dies ist ein mehrzeiliger Kommentar, diese Zeilen werden von PHP ignoriert. */ |
Ebenso kann man Kommentare dazu verwenden, Code auszukommentieren, ohne ihn löschen zu müssen.
Leerzeichen bei der Bezeichnung einer Variablen spielen bei der Ausgabe eines Variablennamens keine Rolle. Sie werden ignoriert. Das Semicolon bezeichnet das Ende der Variablenbezeichnung.
|
1 |
$Hauptstadt = 'Berlin'; |
wird genauso ausgegeben wie
|
1 2 3 |
$Hauptstadt = 'Berlin'; |
Auch wenn Leerzeichen wie in diesem Beispiel keinen großen Sinn machen, so können Leerzeichen in einer Datei bei Bedarf für eine bessere Lesbarkeit verwendet werden.