Coding Style - GameEngineKoblenz/GeKo GitHub Wiki

Alles wichtige zum Nachlesen: http://geosoft.no/development/cppstyle.html

###Allgemein###

  • einfacher Code / gut lesbarer Code
  • klare Bezeichnungen und Namen
  • alles in Englisch
  • Im Headerfile wird nichts implementiert
  • Membervariablen werden m_name genannt.
  • private Variblen werden _name genannt.
  • Für Einrückungen werden 2x Leerstelle genommen.
  • Methodennamen: dasIstEinMethodenname (ohne _ oder ähnliches)
  • Klassennamen: DasIstEinKlassenname
  • Header File: wir benutzen #pragma once statt #ifndef ... (siehe unten)
  • Variablen bei der Instanziierung einen Wert zuweisen. Bsp: int i = 1;
  • Konstanten und Enumerations werden in Caps mit Unterstrichen als Trennung geschrieben static const int WINDOW_SIZE = 600; Aber nicht bei const int windowSize = 600;

###Kommentare###

  • wir benutzen Doxygen für das Erstellen einer Dokumentation unserer Klassen und Methoden. Hierzu bitte vor alle Methoden eine Kurz und eine Langbeschreibung der Methode/Klasse schreiben.
  • // für Kommentare die nur im Sourcecode zu sehen sind.
  • /// für Kommentare die später in der Kurzbeschreibungung in der Dokumentation stehen.
  • /** ... */ für Kommentare, die später in der langen Beschreibung in der Dokumentation stehen.

###Beispiele## Header file:

#pragma once  
#include<Ordner/Datei.h> 
  
class Dateiname  
{  
public:  
//Hier kommen alle Methoden rein, die public sind
  
protected:  
//...das gleiche mit protected...  
  
private:  
//...und private  
  
};