Guter Code?

caramba12321

blödefragensteller
Hi,
Ich wollte mal fragen, was eigendlich ein guten PhP Code ausmacht und worauf mann achten muss.
Ein großer Fehler z.B. ist ja das viele User per Leertaste und nicht per Tab einrücken, wobei dies doch die Kapazität des Scriptes verringert.
Wäre nett wenn ihr mir noch ein paar Sachen nennt und vllt ein oder zwei kleine Beispiele zeigt.

Gruss
Caramba
 
Ich finde Code einrücken machen nur Anfänger und die nichts vom programmieren verstehen. Wenn es schnell gehen soll und das muss es in dieser Welt, dann schreibt man es einfach alles eben untereinander und gut ist
 
Meinst du nich, dass es wenn mann z.B. ein mehrseitiges Script schreibt besser ist, wenn man den code einrückt? Alleine schon wegen der Übersicht usw. Natürlich spielen hier Kommentare auch eine wichtige Rolle.
 
@officemouse
Achso, du Schlauberger: Hast du dir mal den Code eines PEAR-Peketes Angeguckt, da sind sogar die Kommentare eingerückt und unterliegen strengen Regeln.

Also die Einrückung erhöht bei großen / komplexen Programmen enorm die Übersichtlichkeit. Auch wird es anderen Programmierern einfacher gemacht, den Code zu verstehen, wenn eine normierte Einrückung verwendet wird.

Gerade einen guten Programmierer macht es aus, sein Skript nach dem Prinzip des OpenSource verständlich und übersichtlich zu strukturieren.

Also du bist ein Profi ...
 
Nein du das denke ich nicht. Ich mach gerade ein Praktikum in einer Firam die den ganzen Tag nur programmieren und da wird NICHT ein Stück Code eingerückt!
 
officemouse hat gesagt.:
Ich finde Code einrücken machen nur Anfänger und die nichts vom programmieren verstehen. Wenn es schnell gehen soll und das muss es in dieser Welt, dann schreibt man es einfach alles eben untereinander und gut ist

Und ganz wichtig keine Kommentare einbauen damit sich später keine Sau im Code zurecht findet und man sich da das Monopol sichern kann. Alle Fehlermeldungen mit einen @ Zeichen unterdrücken.Klassen und funkionen brauch sowieso kein Schwein wir erfinden das Rad lieber gleich neu, obwohl ein solcher Code eventuell mehrmals benötigt werden könnte.

Und von wegen Untereinander alles Nebeneinander schreiben.

Was ich unter guten Code verstehe nun :

- Ich splitte das auf in dem ich das "Programm" auf mehere Scripte verteile. Also so das wenn ich eine Tabelle für den Header brauch mach ich eine Datei mache mit dem Namen index_header.php und dort kommt nur die Tabelle für den header rein mehr nicht.
- feste Variablen kommen als Konstanten in ein config_inc.php rein. So kann man sie später leichter ändern.
-Keine Fehlermeldungen/Warnungen oder Notizen auch nicht mit einen @zeichen unterdrücken
- einrücken natürlich und Kommentare noch dazu. Sonst kommt man später selber durcheinander wenn es zuviel wird.

Achso ich mach auch eben ein Praktikum , und dort muss ich den Code weiter reichen zu jemanden der sich weniger damit auskennt als ich. Für ihn ist es wichtig das er sehen kann wenn er mal was ändern muss am Layout wo er das ändern muss.

Adressbuch als Beispiel , wir könnten das alles in eine Datei machen natürlich mittels riesigen swtch case abfragen und if else anweisungen. Und irgendwo in Zeile 2321 kommt dann mal die Checkbox die diesen Namen hat, den er eben sucht und diesen ändern will.Da wird er sich aber freuen eben diesen nicht zu finden. So macht er sich die Datei Adressbuch_ausgabe.php auf , 100 Zeilen und leicht zu finden. 10 sec Arbeit und nicht 20 min duch den Code wühlen.
 
Zuletzt bearbeitet:
@officemause:
Es ist eher genau das Gegenteil, Anfaenger ruecken wesentlich weniger ein als Leute die schon Erfahrung mit der Programmierung haben.
Es gibt einfach wesentlich bessere Uebersicht und hilft ungemein dabei Fehler aufzuspueren.
Gut eingerueckter Code ist einfach besser les- und wartbar, vor allem in Anbetracht darauf, dass evtl. auch mal jemand mit dem Code arbeiten muss der ihn nicht aus dem eigenen Aermel geschuettelt hat.

@caramba12321:
Der PEAR-Coding-Standard sieht vor, dass per Space eingerueckt wird, dies hat, wenn ich mich recht erinnere mit unterschiedlichen Tab-Laengen in verschiedenen Systemen/Editoren zu tun. Dadurch soll sichergestellt werden, dass der Code immer gleich aussieht.

Guter Code, um beim Beispiel PHP zu bleiben, ist Code der in moeglichst vielen Umgebungen laeuft, also sich nicht von diversen Einstellungen die in der php.ini vorgenommen werden koennen beeindrucken laesst.
 
Schlechter Code ist für mich, wenn ich so etwas lese:
PHP:
$irgendwas = "$wasanderes";
;)

Spontan würde ich noch folgendes ergänzen:
  • Trenne Code vom Design - setze PHP-Code mindestens in einen eigenen Block am Anfang der Seite bzw. verwende (besser) ein Template-System.

  • Eine konsequente Einrückung und Klammeranordnung sollte selbstverständlich sein.

  • Zeichenketten (s.o.) sollten mit dem Verknüpfungsoperator zusammengesetzt werden:
PHP:
$irgendwas = "Hallo ".$welt."!";
  • Wiederverwendete Funktionen bzw. Klassen sollten in externe Dateien ausgelagert werden.

  • Ich bevorzuge ein Minimum an Leerzeichen zwischen Operatoren, um die Lesbarkeit zu erhöhen. z.B. statt:
PHP:
for($i=0;$i<$array["foo"];$i++) {
    $bar.="bla".($i*2)."<>";
}
so was:
PHP:
for ($i = 0; $i < $array["foo"]; $i++) {
    $bar.= "bla".($i * 2)."<>";
}

  • Ein Mindestmaß an Sicherheit einhalten: $_GET/$_POST statt Direktzugriff (register_globals: off) verwenden und niemals etwas per include einbinden, was als Parameter übergeben wurde.

  • Ansonsten: Alles beachten, was auch für andere Sprachen gilt: Sinnvolle Bezeichner verwenden, nicht mehr als eine Anweisung pro Zeile, Strukturen nicht unnötig mit break; verlassen, aussagekräftige Kommentare usw.

Gruß
.
 
Zurück