[Corvin]

Aufbau von PHP-Code
Ich erläutere hier kurz einen kleinen Ansatz, um die Lesbarkeit und Verständlichkeit von PHP-Code durch einen strukturierten Aufbau zu steigern.
Ich rede hier ausschließlich von "PHP-Code" und "PHP-Skript" usw. Dieser Ansatz gilt aber auch für alle anderen Programmiersprachen (Prolog&Co bilden eine Ausnahme).

Der Aufbau eines PHP-Skripts
Ich empfehle, jedes PHP-Skript wie folgt aufzubauen:



Hier nochmal ein Beispiel:

PHP-Code:

<?php
// Einbinden von externen Dateien
include("config.inc.php");
include("functions.inc.php");

// Deklaration von Konstanten
define("REPEAT", 100);
define("ROWS", 10); 

// Deklaration von Variablen
$i = 0;
$nums = "";

// Deklaration von Funktionen
function make_nums($nums) {
    for ($i=0; $i<REPEAT; $i++) {
        $nums .= $i + 1 ."<br />";
    }
    $nums .= "</nums>";
    return $nums;
}

// Das eigentliche Skript
$nums = make_nums($nums);
echo $nums;
// weiterer Code
?>

Variablen, die in mehreren Skripten gebraucht werden, werden in einer Datei ausgelagert und eingebunden, das Gleiche gilt für Funktionen.

Konstanten, die irgendwo im Skript gebraucht werden, werden alle zusammen oberhalb des Skripts deklariert. So hat man einen gut Überblick darüber, welche Konstanten im Sktipt benutzt werden.

Variablen werden gleich nach den Konstanten deklariert. Ja, ich weiß, man muss Variablen in PHP nicht deklarieren. Wenn man dies aber doch tut, hat man immer die Möglichkeit, die Variablen mit einem Kommentar zu versehen und wie bei den Konstanten auch, hat man einen guten Überblick über alle Variablen im Skript.

Nach den Variablen werden die Funktionen deklariert.

Es spart ungemein Zeit, wenn man bei der Wartung eines Skripts alle Konstanten, Variablen und Funktionen auf einen Blick hat.

Und ganz zum Schluss folgt das eigentliche Skript.

Sicher ist dieser Aufbau sehr ungewohnt und das Schreiben eines Skripts mit diesem Aufbau dauert vielleicht ein wenig länger, doch der Aufwand lohnt sich! Durch diese verbesserte Übersichtlichkeit und Lesbarkeit des Codes ist später ein zielsicheres Überarbeiten des Codes problemlos möglich (sowohl für dich als auch für andere). Im Endeffekt spart dieser Aufbau also Zeit (und Arbeit)!

Weiterhin sollte der Code auch richtig eingerückt werden, um die Übersichtlichkeit des Codes zu steigern. Mehr dazu gibt es hier.

[lokari]

Hi Corvin,

ich finde das einen klasse Ansatz - vielen Dank dafür.

Was hältst Du von der Idee das ganze zu einer Art Muster-Coding-Guideline auszuarbeiten?

Ich könnte mir gut vorstellen, dass man damit gerade Neulingen (wie mir *g*) helfen könnte - evtl. kann sich aber ja auch der ein oder andere "alte Hase" etwas davon abgucken.

[Ben]

@lokari:
Schau mal hier:
Punkt 7 .

Vielleicht hilft dir das auch etwas weiter.

[lokari]

Hi ben,

danke für den Link - ich hab das Tutorial schon gelesen.

Mein Gedankenansatz war eher etwas "eigenes" mit den Leuten hier im Forum zu entwickeln. Klar kann das auch jeder für sich machen, aber evtl. würde es dem ein oder anderen auch was bringen, soetwas gemeinschaftlich aufzubauen.

just my 2 cent...

[Corvin]

Zitat von lokari

Was hältst Du von der Idee das ganze zu einer Art Muster-Coding-Guideline auszuarbeiten?

Das ist eine sehr gute Idee, ich hatte daran selbst schon gedacht. Ich wollte mir mal so eine Art Mini-Framework bauen, freud mich, dass dort Nachfrage besteht und das denn nicht nur mir alleine was nützt. Die Fertigstellung dessen wird natürlich ein wenig länger dauern.
Ich werde dazu mal ein paar genauere Überlegungen anstellen und mich hier dann nochmal melden.

[lokari]

Das ist eine sehr gute Idee, ich hatte daran selbst schon gedacht.

das trifft sich ja gut

Ich kann Dich auch gerne unterstützen - habe schon einiges an Codingguidelines gelesen und mit ausgearbeitet. Mir fehlt nur der praktische Bezug etwas - aber ich arbeite dran

[Buhmann]

Gutes Tutorial, aber mach doch besser die dekleration von $i raus. Da die Variable in einem ganz anderem Gültigkeitsbereich verwendet wird, verwirrt sie mehr, als dass die dekleration hilfreich ist. Besser wäre es, die Variable am Anfang der Funktion zu deklarieren.