OC Coding Style

Aus Opencaching-Wiki
Version vom 28. Juli 2013, 15:56 Uhr von Bohrsty (Diskussion | Beiträge) (Klammersetzung/Einrückung und Kontrollstrukturen erstellt)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

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.

Klammersetzung/Einrückung

Die Klammersetzung/Einrückung erfolgt im Allman-Stil, die öffnende geschweifte Klammer steht in der folgenden Zeile (durch einen Zeilenumbruch von Kontrollstruktur und Bedingung/Parameter getrennt).

if (...Bedingung...)
{
	Anweisung1;
	Anweisung2;
}

oder

class ClassName
{
	...
}

oder

function functionName (...Parameter...)
{
	...
}

Kontrollstrukturen

Für alle Kontrollstrukturen gilt, zwischen dem Namen der Konstrollstruktur und der öffnenden Klammer der Bedingung ist ein Leerzeichen zu setzen.

foreach (...Bedingung...)

oder

function functionName ([...Parameter...])

if

Bei if-Statements soll wenn möglich die verkürzende Schreibweise verwendet werden:

Einzeilige Anweisungen (eingerückt)

if (...Bedingung...)
	Einzeilige Anweisung;
else
	Einzeilige Anweisung;

Bei Variablenzuweisung soll das if-Statement mittels Trinitäts-Operator verwendet werden:

$variable = (...Bedingung... ? ...Wenn-Wert... : ...Sonst-Wert...);