PHP Code Design Guide

Software-Produkte unterliegen einem kontinuierlichen Wachstum, gleichermaßen in Anzahl, (Funktions-)Umfang und Komplexität. Zusätzlich wächst der an der Produktentwicklung beteiligte Mitarbeiterstamm, sodass die Zahl der unterschiedlichen Einflüsse auf den Programm-Quelltext permanent steigt. Daraus ergibt sich nun die Notwendigkeit, zur Verbesserung von Wartbarkeit und Wiederverwendbarkeit eine Grundlage für die unternehmensweite Konsolidierung des wichtigsten Erzeugnisses zu schaffen: Des Quelltextes.

Anwendungsbereich

Sinn und Zweck des Code Design Guide

Der mit diesem Dokument vorliegende Code Design Guide soll einerseits den Entwickler dabei unterstützen, bereits bestehenden Quelltext nach bestimmten Vorgaben neu zu strukturieren und dadurch seine Lesbarkeit und Wartbarkeit zu verbessern, andererseits soll er sowohl dem Erfahrenen als auch dem Einsteiger bei der Erstellung neuer Programmteile die Regeln und Maßstäbe vermitteln, die zur Erhaltung eines qualitativ hochwertigen Entwicklungsstandards unerlässlich sind.

Letztlich ist es der Entwickler selbst, der über sein eigenes "Schicksal" und das seiner Kollegen entscheidet, wenn er einen guten Stil konsequent verfolgt oder auch vermeidet. Spätestens, wenn man selbst alten oder fremden Code warten oder erweitern muss, wird man eine gute Lesbarkeit sehr zu schätzen wissen. Eine gelungene Code-Struktur transportiert bereits seine Bedeutung. Damit beweist man nicht nur seine Skills, sondern erleichtert gleichzeitig Teamkollegen und etwaigen Nachfolgern die Arbeit. Am besten gelingt dies, wenn der Code möglichst kompakt und sauber gehalten wird.

Der Artikel PHP Code Design Guide wurde 2015 von meinem ehemaligen und hochgeschätzten Kollegen Carsten Zahn in @Atlassian verfasst und ist bedauerlicher Weise nur für interne Mitarbeiter einsehbar.

Inhaltsverzeichnis - PHP Code Design Guide

 

Ungarische Notation

Bei der ungarischen Notation handelt es sich um eine von Programmierern verwendete Namenskonvention zur Wahl von Bezeichnern für Variablen und Konstanten, Funktionen und Methoden sowie anderen Objekten.

Mehr ...

PhpStorm effektiv nutzen

Welchen „Werkzeugkasten“ braucht man als PHP-Entwickler? Es gibt eine Reihe nützlicher Tools, die jeder PHP-Entwickler kennen sollte. Die Entwicklungsumgebung PhpStorm bietet Developern eine hilfreiche Unterstützung um PHP-Quellcode pragmatisch und effizient zu bearbeiten.

Code Review

Code Reviews führen gerade im PHP-Bereich zu einer höheren Qualität des Codes, mehr Sicherheit und zu einer bessere Effizienz