.Das Wichtigste am Code ist ein einheitlicher Stil.
Dazu zählen folgende Aspekte:
- Maximale Zeilenlänge
- Art der Zeilenumbrüche (Windows oder UNIX/Linux)
- Zeichen für die Einrückung (Tabs oder Spaces)
- Wenn Spaces zur Einrückung genutzt werden, die Anzahl pro Schritt
- Konventionen für Operatoren
- Konventionen für die Variablennamen
- Konventionen für die Funktions- und Methodennamen
- Konventionen für Kontrollstrukturen (if und switch)
- Konventionen für Schleifen (for, foreach, while, do)
- Konventionen für Klassen- und Methodenrümpfe (Position der geschweiften Klammer)
1. Zeilenlänge, Zeilenumbrüche und Einrückung
Ihr solltet euch an eine maximale Zeilenlänge halten und diese in keinem Fall überschreiten. Damit kann man unnützes horizontales Scrollen in der IDE verhindern. Früher war diese Grenze bei 80 Zeichen pro Zeile, Mittlerweile sind 120 Zeichen üblich.
Die anderen beiden Dinge sind für die Darstellung in Editoren bzw. IDEs wichtig. Da die meisten PHP-Skripte unter einen unixoiden Betriebssystem laufen werden, empfiehlt es sich immer UNIX/Linux Zeilenumbrüche zu benutzen (auch wenn Notepad damit nicht umgehen kann).
Werden für die Einrückungen Tabs benutzt, so kann sich der Code optischen von IDE zu IDE unterscheiden. Je nachdem wie die Schrittweite für Tabs eingestellt ist. Aus diesem Grunde sollte man hier Spaces verwenden, Dabei sollte eine Einrückungsstufe vier Leerzeichen entsprechen.
2. Operatoren
Es gibt mehrere Möglichkeiten um Operatoren von Operanden zu trennen.
Variante eins: Platzsparen. Kann man machen sieht aber nicht gut aus.
Code php:
1 2 | $my_var = $a.$h."foo".$m."j".$x.$i."bar".$z;
$line_count = $z1+$z2/6*13-$xv29+pow(38,2); |
Um das ganze besser lesbar zu gestalten, trennen wir die Operatoren mit Leerzeichen.
Code php:
1 2 | $my_var = $a . $h . "foo" . $m . "j" . $x . $i . "bar" . $z;
$line_count = $z1 + $z2 / 6 * 13 - $xv29 + pow(38, 2); |
3. Konventionen für Variablen-, Funktions- und Methodennamen
Die Namen von Variablen, Funktionen und Methoden sollten auch einheitlich "gestaltet" werden. Mit zunehmender Erfahrung hat sich herausgestellt, dass Camel-Case am verständlichsten ist. Des Weiteren sollten sie in Englisch geschrieben sein.
Achtet im folgenden Beispiel, mal darauf,welchen Code ihr schneller erfasst habt.
Code php:
1 2 3 | function generate_my_code($paramter_one) {
echo "foobar".$my_var;
} |
Code php:
1 2 3 | function echoFooBar($firstParameter) {
echo "baz" . $firstParameter;
} |
Beispiel 1: Namen mit Unterstrichen
Beispiel 2: Namen in Camel-Case
4. Kontrollstrukturen und Schleifen
Auch bei den ganzen if's, for's gibt es Stilregeln. Diese Regeln bestimmen die Position der Bedingungen und der geschweiften Klammern. Von der if...endif; Syntax rate ich ab, da man dort den Block nur schwer erkennt. Analog gilt gleiches für for und foreach.
Auch hier kann man den Code wieder platzsparend gestalten, aber das ist aus meiner Sicht unübersichtlich.
Code php:
1 2 3 4 5 6 7 8 9 | if($a==$b){
}
switch($x){
case "z":
doSomething();
break;
default:
DoSomethingElse();
} |
Code php:
1 2 3 4 5 6 7 8 9 | if ($a == $b) {
}
switch ($x) {
case "z":
doSomething();
break;
default:
DoSomethingElse();
} |
5. Konventionen für Klassen- und Methodenrümpfe
Und auch hier sind die Positionen der (geschweiften) Klammern und Leerzeichen bei Parametern interssant.
Hier will ich nur zwei Beispiele zeigen, da ich mich sonst zu oft wiederhole.
Code php:
1 2 3 | function myFunction($firstParam,$secondParam){
// some code
} |
Code php:
1 2 3 4 | function myFunction($firstParam, $secondParam)
{
// some code
} |
Bevor ich zum Schlusswort komme nochmal ein komplettes Beispiel:
Platzsparend
Code php:
Und das ganze mit einheitlichem Code-Stil:
Code php:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | class MyObject
{
private $array;
private $string;
public function __contruct($firstParam, $secondParam=null)
{
if (is_array($firstParam)) {
$this->array=$array;
}
if ($secondParam!==null && is_string($secondParam)) {
$this->string=(string)$secondParam;
}
}
} |
Einige denken jetzt sicher "ach der Code ist nur für mich, da brauche ich so etwas nicht". Das dachte ich auch einmal, aber im Laufe der Zeit wurde die Pflege des Codes immer schwieriger. Und auch bei einem Hilferuf (z.B. hier im Forum) ist es für die Helfenden leichter das Problem zu lösen, wenn sie sauberen Code zu sehen bekommen.
Das ganze würde nur wenig bringen, wenn es dafür nicht Unterstützung durch Tools gäbe.
Das Tool PHP_CodeSniffer führt eine statische Code-Analyse durch und sagt euch, wo ihr gegen den Code-Stil verstoßen habt. Persönlich nutze ich eine modifizierte Version des Zend Conding Standards.
Das war es zu Teil 1 meiner Serie. Im zweiten Teil wird es um objektorientierte Programmierung (OOP) und Unit-Tests gehen.
Gruß Kyoya Stefan
PHP-Developer bei der Mayflower GmbH
Login
Bereiche
Kategorien
Forum - Programming
Shop @ tutorials.de
tutorials.de-Systemmitteilung