PHP Coding Standard

Logo: PHP
4. Regel 1: Das Prinzip der Einfachheit: Don't make me think!

Das Prinzip der Einfachheit besagt: "Don't make me think!" Sinngemäß übersetzt heißt das: "Bringe mich nicht zum Nachdenken!"
Wenn man also eine lange und komplizierte Funktion durch eine Klasse mit vier oder fünf übersichtlichen Methoden ersetzen kann, so ist der Aufwand nahezu immer gerechtfertigt. Kann man komplexe und unstrukturierte iterative Programmierung durch eine elegante Rekursion ersetzen, sollte man diese Arbeit nicht scheuen. Diese Arbeit gehört zum Programmieren, sie ist Teil des Refactoring.

Zitat von Steve Krug ("Don't make me think! Web Usability", Seite 11)
Die Leute fragen mich oft:
"Wenn ich ich sichergehen will, dass meine Webseite einfach zu benutzen ist, was ist das Wichtigste, das ich beachten muss?"
Die Antwort ist einfach. Sie lautet nicht: "Alles Wichtige darf nicht mehr als zwei Klicks entfernt sein" oder "Sprich die Sprache der User" oder auch "Sei konsistent". Sie lautet ...
"Don't make me think!"
Seit Jahren erzähle ich Leuten, dass dies mein Erstes Gesetz zur Usability ist. Und je mehr Webseiten ich mir anschaue, desto überzeugter bin ich davon.

Steve Krug navigiert mit dem Auto lieber durch Los Angeles als durch Boston, weil die Straßenschilder deutlich zu sehen und die Straßennamen in großen Buchstaben geschrieben sind.

Das Prinzip der Einfachheit findet man überall im Leben, aber in der Programmierung wird es nur selten angewendet. Hier ist das Hauptprinzip: "Hauptsache es läuft!". Es sollte jedoch das Prinzip der Einfachheit sein. Code sollte modular, wartbar und wiederverwendbar sein.

Zitat von Jörg Krause ("PHP5 - Grundlagen und Profiwissen", Seite 349)
Code-Konventionen sind (aus Sicht des PHP-Parsers) unverbindliche Vorschriften oder Empfehlungen zur Schreibweise von Variablen und Funktionen. (...) Neben den vielen Vorschriften, die eine Programmier- oder Skript-Sprache ausmachen, gibt es auch eine Reihe von Empfehlungen, die Programmierern helfen, gut lesbare und saubere Programme zu schreiben. Die Code-Konventionen sind solche Empfehlungen. Dabei geht es auch um die Pflege der Programme durch andere Programmierer oder später durch Sie selbst. Oft entstehen Programme unter großem Zeitdruck, die nötige Kommentierung und Dokumentation wird nur mangelhaft möglich sein. Die für jede Sprache geltenden Konventionen erleichtern dann das Einarbeiten in fremden oder eigenen Code.

Zum Prinzip der Einfachheit gehören automatisch Struktur und Übersichtlichkeit. Der PHP Coding Standard wird hier verschiedene Mechanismen erklären, um das zu erreichen. Der weltweit wichtigste und weitverbreiteste Standard ist das Einrücken von Code. Es gibt viele unterschiedliche Meinungen zu "Tabs vs. Spaces" (Tabulatoren oder Leerzeichen), sowie die Frage "2, 4 oder 8 Leerzeichen?" beim Einrücken. Hier muss sich das Team einigen.
Die vielen Beispiele in diesem Dokument werden das Einrücken von Code besser erklären, als jede abstrakte Formel.