OC Coding Style

Aus Opencaching-Wiki

Hier werden die style-guidelines für die Entwickler des OC-Codes fortgeschrieben, diese Seite ist unvollständig und enthält derzeit nur einzelne Teile, die aus dem bestehenden Code übernommen wurden, bzw. auf den sich das Entwicklerteam geeinigt hat. Diskussionen hierzu sollten im Entwickerforum geführt werden.

Allgemein sollen die Richtlinien aus PSR-1 und PSR-2 angewendet werden. Für die meisten Entwicklungsumgebungen gibt es auch Plugins, die auf die Einhaltung prüfen und somit für einen sauberen Code sorgen.

Für die Einrückung sollen 4 Leerzeichen verwendet werden - keine Tab-Stopps!

Um den Composer-Autoloader nutzen zu können, müssen Klassen nach PSR-4 benannt und in die bestehende Namespace-Struktur einsortiert werden.