Implementierungsgrundsätze

Zurück zu: Lastenheft: Elektronischer FREMO-Streckenblock

Inhalt:

  1. Coding Style

Coding Style

Also ich seh das nicht so eng, aber da meine bisherigen Sourcen das benutzen, möchte ich das mal dokumentieren. Muesst ihr ja nicht verwenden, aber ich tue es, weil ich das vonne Arbeit so im Rückenmark habe:

Bezeichner allgemein

Alle Bezeichner sind klein geschrieben, fangen mit einem Großbuchstaben an. Zusammengesetzte Wörter haben Am Anfang jedes Wortes einen Großbuchstaben. Beispiel: "NormalerBezeichner"
Unterstriche Werden gemieden. Ganz anders bei #defines und Enumerator-Konstanten, die werden in Großbuchstaben geschrieben und mit Unterstrichen strukturiert. Beispiel: "BEISPIEL_DEFINE".

Typen

Typnamen erhalten ein grossgeschriebenes Prefix, typedefs erhalten ein Postfix "_t":
Typ Prefix Beispieldeklaration
Struktur S 
struct SPoint
{
    unsigned int uiX;
    unsigned int uiY;
};
Enumerator E 
enum EMeetingState
{
    SETTING_UP_E,
    OPERATION_E,
    EATING_E,
    CHATTING_E,
    GOING_HOME_E
};
Array A typedef char ABuffer_t[42];

Variablennamen

Variablennamen erhalten eine kleingeschriebenen Prefix:
Typ Prefix Beispieldeklaration
char c char cKey;
short s short s16BitsAreFun;
long l long l32BitsAreMoreFun;
float f float fNumber;
struc st struct SPoint stOverThere;
enum en enum EState enPreviousState;

Weitere kombinierbare Prefixe:

Typ Prefix Beispieldeklaration
unsigned char uc unsigned char ucLoop;
char * pc char *pcString
void * pv void *pvTransparentData;
unsigned int * pui unsigned int *puiBytesCopied;
char * [] apc char *apcKeywords[42];

Diese Seite wurde zusammengestellt von Stefan Bormann. Site hosted by: SourceForge.net Logo