Vorschläge zur PHP-Code-Gestaltung nach PSR-1
Kommentare

Der PSR-1 Style Guide von Paul M. Jones liefert einige Ansätze, wie sich auch PHP Code auf Basis von PHP 5.4 einheitlich gestalten lässt. Hierzu liefert er Vorschläge zu Einrückung, PHP-Tags, Leerzeilen,

Der PSR-1 Style Guide von Paul M. Jones liefert einige Ansätze, wie sich auch PHP Code auf Basis von PHP 5.4 einheitlich gestalten lässt. Hierzu liefert er Vorschläge zu Einrückung, PHP-Tags, Leerzeilen, Klassen, Eigenschaften und Methoden sowie Kontroll-Strukturen wie Bedingungen oder Schleifen.

Man sollte laut Jones:

  • ausschließlich &#60?php oder &#60?= zum Öffnen verwenden und den schließenden Tag ?&#62 weglassen, falls das Script ausschließlich PHP-Code enthält.
  • vier Leerzeichen verwenden anstelle von Tabs.
  • Zeilen auf 80 bis 120 Zeichen beschränken und Unix-Zeilenvorschübe (line feed) verwenden.
  • alle Klassen namespacen. Nach der Namespace-Erklärung sowie nach der use-Erklärung sollte je eine Leerzeile folgen.
  • Klassennamen in StudlyCaps benennen, die öffnenden sowie schließenden geschweiften Klammern in eigene Zeilen schreiben.
  • Methoden in camelCase benennen und zugehörige Klammern wie bei Klassen behandeln.
  • die Sichtbarkeit der Methoden und Eigenschaften erklären: static geht der Sichtbarkeits-Erklärung voraus; abstract sowie final kommen noch vor static und der Sichtbarkeits-Erklärung.
  • ein Leerzeichen nach Kontrollstruktur-Keywords (if, for, while u.s.w.) lassen, jedoch nicht nach Funktions- oder Methoden-Aufrufen.
  • die öffnende, geschweifte Klammer nach if, for, while u.s.w. in dieselbe Zeile schreiben und die schließende, geschweifte Klammer in eine eigene Zeile schreiben.
  • kein Leerzeichen nach der öffnenden, geschweiften Klammer nach if, for, while u.s.w. setzen und kein Leerzeichen vor die schließende, geschweifte Klammer setzen.

Weitere Erläuterungen liefert Jones auf GitHub. Paul M. Jones berichtet auch in seinem Blog und auf Twitter oft über Neuigkeiten aus der PHP-Welt.

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -