Benutzer-Werkzeuge

Webseiten-Werkzeuge


dev:all:start

Dies ist eine alte Version des Dokuments!


Coding Standards

…, für einige willkommen, für andere wiederum ein rotes Tuch. Dabei wollen Standards nicht vorschreiben, was und wie man programmiert. Sie sorgen einfach nur dafür, dass Quellcode von unterschiedlichen Codern eben die selbe Basis benutzt. Dass jeder problemlos den Code eines anderen lesen und -hoffentlich- auch verstehen kann und dass Quellcode unterschiedlicher Herkunft reibungslos zusammenspielt.

Die Standards für WebsiteBaker wurden jetzt auch nicht neu erfunden und willkürlich festgelegt, sondern wir verwenden prinzipiell die selben, die auch sehr viele andere namhafte Projekte und große Frameworks (siehe PHP-FIG Referenzliste) benutzen. Die grundlegenden Standards für WebsiteBaker sind die Standards PSR-0 / PSR-1 / PSR-2 und PSR-4 der PHP Framework Interop Group.
Auf den nachfolgenden Seiten haben wir die Originalstandards ins Deutsche übersetzt. Vielleicht nicht ganz wörtlich, jedoch absolut sinngemäß. Sehr wenige kleinere, jedoch notwendige Anpassungen sind auf den jeweiligen Seiten vermerkt. Die Kompatibilität bleibt jedoch voll und ganz erhalten. Manche mögen sich an der recht strikten Ausdrucksweise (DAS MUSS!, das DARF NICHT! etc.) stören. Diese Ausdrücke sind aber exakt so aus den originalen PSRs, die sich wiederum strikt an RFC 2119 halten, übernommen worden und sollten auch exakt so verstanden werden.
Die wichtigsten RFC2119-Schlüsselworte wurden/werden nach folgendem Sinn übersetzt:

englisch deutsch Erklärung
MUST / REQUIRED / SHALL MUSS / ERFORDERLICH / SOLL es ist ein absolutes Erfordernis der Spezifikation.
MUST NOT / SHALL NOT DARF NICHT / SOLL NICHT es ist ein absolutes Verbot durch die Spezifikation.
SHOULD / RECOMMENDED SOLLTE / EMPFOHLEN Auch das ist ein absolutes Erfordernis/Verbot. Jedoch kann es in Ausnahmefällen gute Gründe geben, diesen Punkt zu ignorieren. Dazu sollten aber die vollen Auswirkungen der Missachtung gut verstanden und sehr genau überlegt werden ob die Abweichung tatsächlich erforderlich ist.
SHOULD NOT / NOT RECOMMENDED SOLLTE NICHT / NICHT EMPFOHLEN
MAY / OPTIONAL KANN / OPTIONAL hiermit wird eine wirkliche Option bezeichnet, die kann aber nicht muss
  • Autoloading Standard - Er zielt darauf ab, ein standardisiertes Dateiformat sowie Klassennamen und Namespace Konventionen bereitzustellen, die Plug&Play Code ermöglichen.
  • Basic Coding Standard - Hiermit soll ein möglichst hoher Grad an Kompatibilität von PHP-Code aus unterschiedlichen Quellen erreicht werden.
  • Coding Style Guide Enthält Anweisungen, die dafür sorgen, dass PHP-Code immer eine standardisierte optische Erscheinung hat.
  • Improved Autoloading - Eine modernere Interpretation automatischen Ladens, die die weiteren Fortschritte im Ökosystem reflektiert.
  1. Coding Standards #1 Dateiformatierung
  2. Coding Standards #2 Namens Konventionen
  3. Coding Standards #4 Inline Dokumentation

Manuela v.d.Decken 13.08.2014 18:09

dev/all/start.1407946193.txt.gz · Zuletzt geändert: 03.06.2015 15:50 (Externe Bearbeitung)