OldSchoolHack SVN CodeConvention

KN4CK3R

Administrator

Join Date: Aug 2007

Posts: 8643

User-Rating:

199 positive

33 negative

Hallo,

damit der Code im SVN eine einheitliche Form hat, müssen diese Regeln eingehalten werden:

1. aussagekräftige Variablennamen
- kurz, prägnant, sinnvoll, mit Bezug
- Methoden, Variablen, Attribute beginnen mit Kleinbuchstaben
- Klassen beginnen mit Großbuchstaben
- Mehrere Worte mit Großbuchstaben trennen: firstName, lastName
- statische Konstanten werden groß geschrieben: ICH_BIN_EINE_KONSTANTE

CPP Code:

//nicht in Ordnung:
int asd, bla;
char vArIaBle;
 
//in Ordnung
int index, zeit;
char sinnvollerName;

2. Funktionen
- Funktionsnamen beginnen mit einem Großbuchstaben, ansonsten wie bei Variablen

3. Whitespace
- korrekte Einrückung von Quellcode

CPP Code:

namespace Space
{
	class Planet
	{
	public:
		string name;
		int position;
 
	private:
		void destroyPlanet();
	};
}

Kein Whitespace nach
~ (Bitweises Komplement)
! (Logisches Komplement)
++ (Prefix-Inkrementierung, z.B. ++i
-- (Prefix-Dekrementierung, z.B. --i
. (Punkt)
- (Unäres Minus, z.B. -5)
+ (Unäres Plus, z.B. +4)

Whitespace verpflichtend um
= (Zuweisung)
+, +=, -, -=, *, *=, /, /=, %, %=, &, &=, |, |=, ^, ^=
==, !=, <, >, >=, <=
&&, ||,
if, else, for, while, return
...

4. Blöcke
{, } kommen jeweils in eine eigene Zeile

CPP Code:

//nicht in Ordnung
if (true) { } else {
}
 
//in Ordnung
if (true)
{
	//auch einzelne Anweisungen werden bei if und Schleifen von { und } eingeschlossen
}
else
{
 
}

Wär sich an die Regeln hält, hat schön strukturierten Quellcode vor sich.

greetz KN4CK3R

__________________

Hallo