Code schreiben nach Regeln: Code Style und Konventionen für PHP im Team

Teamarbeit: Code Style und Konventionen für PHP

Stellen Sie sich vor, Sie betreten ein fremdes PHP-Projekt. Sie öffnen eine Datei und sehen: Tabulatoren gemischt mit Leerzeichen, Variablen willkürlich benannt und geschweifte Klammern stehen überall, nur nicht dort, wo Sie es gewohnt sind. Kommt Ihnen bekannt vor? Stellen Sie sich nun vor, es gibt Hunderte solcher Dateien, und jede wurde von einem anderen Entwickler geschrieben. Ein Albtraum für Code-Reviews und die Code-Wartung.

In diesem Artikel erklären wir, warum PHP-Code-Style und Code-Konventionen nicht nur eine Laune des Senior-Entwicklers sind, sondern die Grundlage effektiver Teamarbeit. Sie erfahren mehr über die PSR-Standards, Namenskonventionen, Formatierungsregeln und erhalten praktische Beispiele, die Sie sofort in Ihrem Projekt anwenden können.

Warum ist Code Style für das Team wichtig?

Wenn mehrere Entwickler an einem Projekt arbeiten, wird ein einheitlicher Code-Stil zur Rettung. Hier ist der Grund:

\n
• Lesbarkeit. Nach einheitlichen Regeln geschriebener Code kann von jedem Teammitglied leicht gelesen werden. Man muss nicht raten, was der Autor gemeint hat.
\n
• Schnellere Code-Reviews. Wenn der Code einheitlich formatiert ist, konzentriert sich der Reviewer auf die Logik und nicht auf die Formatierung.
\n
• Weniger Fehler. Einheitliche Konventionen verringern die Wahrscheinlichkeit von Fehlern, die durch unterschiedliche Ansätze beim Schreiben von Code entstehen.
\n
• Einfaches Onboarding. Ein neuer Entwickler findet sich schneller im Projekt zurecht, wenn der Code vorhersehbar und strukturiert ist.
\n

Im Grunde sind PHP-Codierungsstandards die Sprache, die das gesamte Team spricht. Je einheitlicher sie ist, desto weniger Missverständnisse gibt es.

Die wichtigsten Standards: PSR und mehr

In der PHP-Welt gibt es mehrere wichtige Empfehlungen, die sich als De-facto-Standards etabliert haben. Die wichtigsten sind PSR-1 und PSR-12 (früher PSR-2). Sie werden von der PHP-FIG (Framework Interoperability Group) unterstützt.

PSR-1: Grundlegende Regeln

PSR-1 beschreibt die allgemeinsten Regeln: Wie man Klassen, Methoden und Konstanten benennt und wie Dateien organisiert werden.

Wichtige Punkte:

\n
• Dateien sollten nur <?php oder <?= (kurzer Tag für Ausgaben) verwenden.
\n
• Dateikodierung ist UTF-8 ohne BOM.
\n
• Klassennamen in StudlyCaps (PascalCase).
\n
• Methodennamen in camelCase.
\n
• Konstanten in Großbuchstaben mit Unterstrichen (MAX_VALUE).
\n

Beispiel für korrekten Code nach PSR-1:

<?php\n\nnamespace App\\Services;\n\nclass UserService\n{\n    const DEFAULT_ROLE = 'user';\n\n    public function getUserById(int $id): ?User\n    {\n        // Logik\n    }\n\n    public function isAdmin(): bool\n    {\n        // Logik\n    }\n}

PSR-12: Erweiterte Stilregeln

PSR-12 ist die Weiterentwicklung von PSR-2. Es fügt weitere Details zur Formatierung hinzu.

Wichtige Punkte:

\n
• Einrückung: 4 Leerzeichen (keine Tabulatoren).
\n
• Geschweifte Klammern werden in derselben Zeile für Klassen, Methoden und Kontrollstrukturen geöffnet (K&R-Stil).
• Nach Schlüsselwörtern (if, else, while) ist ein Leerzeichen erforderlich.
• Eine Leerzeile nach der namespace-Deklaration und vor dem return in Methoden (optional).
• Zeilen nicht länger als 120 Zeichen (80 werden empfohlen).

Beispiel für korrekte Formatierung nach PSR-12:

<?php\n\nnamespace App\\Controllers;\n\nuse App\\Models\\User;\nuse App\\Services\\AuthService;\n\nclass AuthController\n{\n    private AuthService $authService;\n\n    public function __construct(AuthService $authService)\n    {\n        $this->authService = $authService;\n    }\n\n    public function login(array $credentials): bool\n    {\n        if (empty($credentials['email']) || empty($credentials['password'])) {\n            return false;\n