Website-Struktur und Skript-Stil oder so ähnlich

[foomaker]

Ich möchte mal eine (vermutlich nicht die erste, aber wohl hoffentlich auch nicht die letzte) Diskussion anregen über das spannende (meine ich ernst) Thema "Website-Struktur und Skript-Stil".

Worum geht es?
Stichpunkte: Große website (also groß genug, um planvoll und strukturiert vorgehen zu MÜSSEN), php, html, javascript, perl, dokumentiert, phpdoc

Ich habe Weiterentwicklung und Pflege eine site übernommen, auf die folgende Merkmale zutreffen:

• Skriptstil uneinheitlich
• Spaghetticode
• html, php und javascript fröhlich gemischt
• ganze Skriptteile ungenutzt, weil sich offenbar niemand traute was zu löschen. Es könnte ja in irgendeinem noch zu includierenden Skript zu was nutze sein
• include-Labyrinthe vom Feinsten. Jeder (!!!) Link ruft die index.php mit einem Rattenschwanz an Parametern auf. Von dort aus wird fleissig includiert - bis in die 5. Ebene.
• apropos Parameterübergabe: Mal session-Vars, mal post, mal get - keinesfalls ein System erkennbar.
• Dokumentation Fehlanzeige
• tote Skripte, die nur zu Testzwecken mal erstellt, aber nie eingebunden wurden
• und und und

Nun ist also ein "Kollege" der Ansicht, das sei üblicher Skript-Stil. Ich wiederum sehe das ganz anders. Aufgeräumter Code, Dokumentation, einheitlicher Stil, Übersichtlichkeit, Struktur sind meiner Meinung nach das A & O guter Programmierung. Einwand "Kollege": "Das kostet doch alles viel zu viel Zeit."
Das kostet Zeit - da hat er wohl Recht, aber Zeit, die sich am Ende wieder rechnet - nämlich bei Erweiterungen und Änderungen, wenn man nicht tagelang ergründen muss, was sich der Skripter wohl bei diesem und jenem gedacht haben könnte.

Manches ist sicher begründet auf persönlichen Vorlieben. Aber auch, wenn ich vlibTemplate sehr schätze, also php und html strikt trenne, käme ich doch mit sauberer heredoc-Syntax klar, wenn denn dies einer bevorzugen sollte. Darum gehts mir nicht.
Aber php-Code, der vor Variablen strotzt (einheitliche Gross- und Kleinschreibung übrigens Fehlanzeige, weil's ja "egal" ist) wie z.B. "$kn" für Kundennummer statt $kundennummer oder wenigstens $kdnr, macht mir eine Gänsehaut des Grauens. ;-)

Also ich rede nicht von Geschmacksfragen, sondern von einer Art "Grundregeln für sauberen Programmierstil" - sicherlich übergreifend gültig auch für Perl, Java, Delphi, C++ u.a.

Wie ist Eure Meinung? Habt Ihr eine "Bibel" für so etwas? Wie wichtig ist Euch dieses Thema? Wie sind eure Erfahrungen? Includiert Ihr auch auf Teufel komm raus, weil das "das Einfachste" ist? Dokumentiert Ihr ordentlich, vieleicht wie ich mit phpdoc?

So, lass mal lesen. ;-)

Gruß vom foomaker