In dem 3. Teil des PHP Tutorials werden wir uns mit einer relativ nicht funktionellen aber trotzdem sehr produktiven Funktion beschäftigen: Mit dem Kommentieren von Scripten. Dies wird grundlegend sein, da in den nächsten Kapiteln über Variablen etc. viele Textstellen im Quellcode kommentiert sein werden, um nicht alles unter bzw. überhalb des Codeblocks erörtern zu müssen.

Was sind Kommentare?
In PHP werden Textstellen, die vom PHP Modul beim Ausführen ignoriert werden als Kommentare bezeichnet. Sie werden beim Ausführen aus dem Speicher entfernt und übergangen. Jetzt stellt sich natürlich die Frage, was für einen Sinn es gibt, ein Script mit Text zu füllen, der gar nichts bewirkt. Nun technisch gesehen bewirken Kommentare wirklich nicht - doch vom grundlegenden Nutzen sind sie sehr wichtig. Kommentare dienen zur Information bzw. Kommentierung in dem Script. Sie sollen dazu dienen, dem Programmierer einen Überblick bzw. eine Erklärung zu Funktionen und Codeabschnitten zu geben. Gerade wenn man ein Script länger nicht öffnet bzw. im Team arbeitet, sind Kommentare das A und O. Wer gute Kommentare schreiben kann - das heißt, an den richtigen Stellen sowie nicht zu viel und nicht zu wenig - hat viele Vorteile und hat den Grundstein zum guten [übersichtlichen] Programmierer. Sie sind vergleichbar mit den <!-- und --> Kommentaren in HTML.

Syntax von Kommentaren
Es gibt 4 Arten von Kommentaren in HTML, von denen eigentlich nur 2 verwendet werden. Im folgenden Beispiel werden wir nur die zwei wichtigen Arten behandeln, die anderen existieren im Grunde nur noch in der Theorie, Anwendungen gibt es fast keine mehr.

<?php
echo 'Text'; // => Einzeiliger Kommentar
echo 'Einzeiliger Kommentar endet am normalen Zeilenende';
?> 

Die erste Art von Kommentare sind die einzeiligen Kommentare. Sie beginnen mit einem doppelten Slash '//'. Alles was in dieser Zeile nach den beiden / steht, ist ein Kommentar. Sie dienen zu kurzen Funktionserklärung und sind wohl die am häufigsten verwendeten Kommentare. Neben dem Zeilenende, beendet auch der End-Tag ?> einen Kommentar.

<?php
echo 'Text'; // Kommentar ?><?php echo 'Kommentar durch
?> beendet.';
?> 

In diesem Beispiel tritt der oben genannte Fall ein, der PHP-End-Tag beendet den Kommentar.

Die andere Art von Kommentaren sind die mehrzeiligen Kommentare, oft für längere Erklärung von Funktionen, Klassen etc. verwendet.

<?php
echo 'Text';
/* Ausgabe eines Textes => Mehrzeiliger Kommentar
   Ich kann in dieser Zeile in Kommentarform
   weiter schreiben, ohne PHP das extra zu sagen. */
?> 

Mit dem Befehl /* startet man einen mehrzeiligen Kommentar, alles bis zum nächsten */ wird ignoriert. Der Befehl */ beendet alle offenen mehrzeiligen Kommentare. Verschachtelungen sind somit nutzlos, da ein */ auf 3 vorangehende /* gleich wirkt:

<?php
echo 'Text';
/* Erster geöffneter mehrzeiliger Kommentar
/* Zweiter geöffneter mehrzeiliger Kommentar
Ende des erstes UND zweiten Kommentars */ 
?> 

Ein weiterer */-Befehl würde ein Parse Error hervorrufen.

Dies sind die grundlegenden Informationen über Kommentare, im nächsten Kapitel des PHP Tutorials werden wir uns dann den Variablen widmen. Zu diesem Kapitel sei als Anhang noch hinzugefügt, dass alle führenden Open Source Scripte vollständig in Englisch kommentiert sind. Linus Torvalds [finnischer Staatsbürger] wäre es nie im Leben eingefallen, den Code des ersten Linux Kernels in Finnisch oder irgendeiner anderen Sprache als Englisch zu kommentieren.
=> Englisch ist und bleibt die Weltsprache in Sachen Programmierung, deswegen sei angemerkt, dass man sich umbedingt das Kommentieren in Englisch angewöhnen sollte.

[Copyright 2009-2010 by Robin Rump, robinrump.com. All rights reserved. Do not copy, edit or publish without asking author.]