Sven Rautenberg: Guter Programmier Stil

Beitrag lesen

MoiN!

kennt jemand ein paar tutorials oder so, in denen ein guter programmierstil vermittelt wird, am besten für php

Kennen tu ich keine, aber Google kennt wohl welche: "programming style" oder "programmieren mit stil" brachten Suchergebnisse.

Das Problem wird sein, daß die besten Texte nur in englisch verfügbar sind. Aber wenngleich du nicht unbedingt ein Tutorial für PHP findest, ist eine Richtlinie für Java, C++ oder Perl genauso hilfreich, weil es in erster Linie um Grundprinzipien geht, wie man Code lesbar und möglicherweise selbstdokumentierend gestaltet.

Wo ich gerade dabeibin:

Das Mini-Tutorial des guten Programmierstils, Version 0.1

Prinzip Nummer 1: Einrücken!
Nur wenn auf den ersten Blick sichtbar wird, welche Anweisungen alle z.B. in Schleifen und IF-Abfragen enthalten sind, behält man die Übersicht. Und es hilft ganz entschieden, Fehler zu vermeiden und gemachte Fehler schneller zu finden.

Prinzip Nummer 2: "Sprechende" Variablen- und Funktionsnamen benutzen.
Niemandem ist damit gedient, wenn eine Variable "blabla" oder eine Funktion "mach_es" heißt. Üblicherweise ist es sehr sinnvoll, den Variablennamen so zu wählen, daß die Bedeutung des enthaltenen Wertes klar wird, auch wenn das Tipparbeit bedeutet. Schlau ist es z.B., das Ergebnis einer Datenbankabfrage im Array "abfrageergebnis" abzulegen, und die Variable für den Dateinamen des Newstickertextes "tickerfilename" zu nennen. Ganz lokal begrenzte Allerweltsvariablen wie die für eine unbedeutende Schleife dürfen gerne auch kurz "i" und "j" heißen, das sind übliche Bezeichnungen für irgendeine Laufvariable. Deutsche oder englische Namen? Geschmackssache. Englisch paßt meist besser zu den englischen Befehlen, aber deutsch ist möglicherweise erklärender für den Programmierer. Aber Vorsicht: Keine Umlaute!

Prinzip Nummer 3: Kommentare!
Guter Code erklärt sich zwar selbst, aber es hat noch niemals geschadet, am Anfang einer Funktionsdefinition die Bedeutung der zu übergebenden Parameter zu erklären oder bei wichtigen Vorgängen kurz zu erläutern, was das geniale an der verwendeten Programmierung ist, bzw. was für Gedankengänge dabei gegangen wurden. So muß derjenige, der später den Code liest, nicht mühsam nachvollziehen, was da gemacht wurde, sondern kriegt gleich am Anfang die Informationen und kann so leichter verstehen, was da los ist. Bloß nicht jede Zeile kommentieren, das verdoppelt unnötig die Arbeit, sondern an den wichtigen Stellen.

Soweit das Mini-Tutorial des guten Programmierstils.

PS: Das gilt sowohl für PHP, als auch für Javascript und HTML! Wobei HTML natürlich keine Funktionen und Variablen kennt, aber es gehört eingerückt und durchaus auch kommentiert!

- Sven Rautenberg