Lektion 7: Skripte erläutern/kommentieren
Wie Sie vielleicht auch bei diesen einfacheren Beispielen gemerkt haben, können PHP-Skripte leicht unübersichtlich werden. In dieser Lektion werden wir beleuchten, warum Erläuterungen/Kommentare wichtig sind und wie Sie diese in Ihre Skripte einfügen.
Warum es wichtig ist, Ihre Skripte zu erläutern?
Wenn Sie programmieren, schreiben Sie Kommandos für einen Server/Computer. Sie müssen eine hochformale Sprache benutzen, die wahrscheinlich nicht klar Ihre Gedanken wiedergibt, die Sie hatten, als Sie das Skript erstellt haben.
Deswegen kann es für andere (oder auch Sie selbst) schwierig sein zu verstehen, wie das Skript aufgebaut ist und somit Fehler im Code zu erkennen und zu berichtigen.
Kommentare können dazu verwendet werden, kurze erklärende Texte in den Code zu schreiben. Der Server ignoriert diese Kommentare komplett und die Kommentare beeinflussen nicht die Funktionalität Ihres Skripts.
In der Geschäftswelt ist es oftmals eine Voraussetzung, dass Skripte oder (andere) Programme kommentiert/erläutert werden. Ansonsten könnte es für eine Firma zu riskant sein, ein System zu übernehmen, in dem es schwierig ist Fehler zu finden und zu beheben.
Wie fügt man Kommentare ein?
Es ist ganz einfach Erläuterungen einzufügen. Sie beginnen Ihren Kommentar einfach mit zwei Schrägstrichen: "//".
Schauen wir uns nochmal eines der Beispiele aus Lektion 5 an, dieses Mal mit Erläuterungen:
<html> <head> <title>Schleifen</title> </head> <body> <?php // Hier generieren wir Farbcodes mit drei Schleifen // ROT-Wert kann zwischen 0 und 255 liegen for ($intRed=0; $intRed<=255; $intRed=$intRed+30) { // GRÜN-Wert kann zwischen 0 und 255 liegen for ($intGreen=0; $ intGreen<=255; $intGreen=$intGreen+30) { // BLAU-Wert kann zwischen 0 und 255 liegen for ($ intBlue=0; $intBlue<=255; $intBlue=$intBlue+30) { // Die Farbe wird folgendermaßen generiert rgb(ROT,GRÜN,BLAU) strColor = "rgb(" . intRed . "," . intGreen . "," . intBlue . ")" // Jetzt schreiben wir den Farbcode für die Ausgabe beim Client echo "<span style='color:" . $strColor . "'> " . $ strColor . " </span>"; // Schließt die Schleifen } } } ?>
Des Beispiels wegen haben wir hier viele zusätzliche Erläuterungen eingefügt. Es sollte jetzt klar geworden sein, dass die Fehlersuche in kommentiertem Quellcode wesentlich einfacher ist, als in unkommentiertem.
Deswegen - denken Sie immer daran, Ihre Skripte zu erläutern!