PHP-Programmierung mit Stil – Teil II

von Clemens Gull

Blöcke sind schön! Es ist wirklich so! Die Einrückung um vier Zeichen macht die Blöcke deutlich einfacher lesbar. Und genau das sollten Sie auch machen: Abhängige Zeilen immer um je vier Leerzeichen einrücken. Benutzen Sie keinen Tabulator, denn das kann auf den verschiedensten Betriebssystemen zu Problemen führen.

Für die Einrückung gebe ich wieder ein Beispiel, wie es gut aussieht und auch lesbar bleibt:

...
...
while ($pruef == false) {
    if ($wert <= 5) {
        for($j = 2; $j <= 10; $j++) {
            echo "Wert: ".($wert * $j)."<br/">;
            if ($j == 6) {
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
            } //end of if:Halbzeit
        } //end of for:$j
    } else {
        for($j = 2; $j <= 10; $j++) {
            echo "Wert: ".($wert / $j)."<br/">;
            if ($j == 6) {
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
                echo "*** Halbzeit ***<br/>";
            } //end of if:Halbzeit
        } //end of for:$j
    } //end of if:$pruef
} //end of while:$pruef
...

Sie geben mir sicher Recht, dass der Beispielcode einfach zu lesen ist. Denn man sieht auf einen Blick, was zusammengehört. Dazu gehört auch der bewusste Einsatz von Blockoperatoren. Natürlich gibt es die Gruppe, die Code nur schön finden, wenn er möglichst kurz ist. Aber schöner Code ist einfacher lesbar und verständlich.

//Variante A
$wert = 5;
if ($wert == 5) {
    echo "Fertig!";
}
echo "Lies das hier nochmals ".
     "<img class="wp-smiley" src="http://www.guru-20.info/wp-includes/images/smilies/&quot;.      &quot;icon_wink.gif" alt=";-) " />";
 
//Variante B
$wert = 5;
if ($wert==5)
echo "Fertig!";
echo "Lies das hier nochmals <img class="wp-smiley" src="http://www.guru-20.info/wp-includes/images/smilies/icon_wink.gif" alt=";-) " /> ";

Schauen Sie und urteilen Sie selbst: Ist die Variante A nicht klarer und lesbarer? Auch ich verwende diese Variante, um meinen Code besser zu gestalten.

80 Zeichen sind genug!

Auch hier gibt es alle Typen von Programmierern: Die, die ultrakurze Zeilen schreiben und solche, die elend lange Zeilen programmieren und natürlich alle Schattierungen dazwischen. Ich habe die Erfahrung gemacht, dass es ganz praktisch ist, wenn man sich auf 70 bis 80 Zeichen pro Zeile beschränkt. Erstens passt alles auf eine Bildschirmbreite, und zweitens lässt sich derart formatierter Sourcecode ohne störende Umbrüche auf einer DIN-A4 Seite ausdrucken.

Das Leerzeichen ist Freund und Feind zugleich!

Wenn Sie Leerzeichen bewusst einsetzen, können sie Ihnen wirklich helfen. Versuchen Sie aber einfach nur den Code einzutippen und machen Sie sich über Leerzeichen keine Gedanken, wird er bald nicht mehr lesbar sein. Machen Sie zum Beispiel vor einem öffnenden Blockoperator ein Leerzeichen, das hilft bei der Unterscheidung der Klammern.

if ($wert &gt; 5) {

Auch beim Zuweisungsoperator (Gleichheitszeichen) sind Leerzeichen willkommen. Schauen Sie sich einfach die Varianten an und Sie werden wieder die Variante A (meinen Liebling) lesbarer finden.

//Variante A
$kundenNr = 20314;
$vorName  = "Guru";
$nachName = "2.0";
$web      = "http://www.guru-20.info";
$mehrInfo = "Ich liebe diesen Blog!";
 
//Variante B
$kundenNr = 20314;
$vorName = "Guru";
$nachName = "2.0";
$web = "http://www.guru-20.info";
$mehrInfo = "Ich liebe diesen Blog!";
 
//Variante C
$kundenNr=20314;
$vorName="Guru";
$nachName="2.0";
$web="http://www.guru-20.info";
$mehrInfo="Ich liebe diesen Blog!";

Das Leerzeichen kann aber auch ein Feind sein:

function test ($ausgabe) {
echo $ausgabe;
}

Sobald Sie Leerzeichen zwischen den Funktionsnamen und den Übergabeparameter setzen, sieht es so aus, als ob die beiden nicht mehr zusammengehören.

Dieser Text ist dem Buch “PHP für WordPress” von Clemens Gull entnommen, das im Franzis-Verlag erschienen ist. Das Buch ist hier direkt bestellbar.

Social Bookmarks: These icons link to social bookmarking sites where readers can share and discover new web pages.

Artikel bewerten

(No Ratings Yet)

Loading ...

Kommentare

PHP-Programmierung mit Stil – Teil III | webdeveloper.franzis.de

[...] haben Sie im Teil II dieses Tutorials bemerkt, dass ich beim schließenden Blockoperator auch einen Kommentar angefügt habe. Es ist [...]

PHP-Programmierung mit Stil – Teil II

Artikel bewerten

Weitere Artikel

Kommentare

Kommentar schreiben