Codierungsregeln

Regeln zum Umsetzen von Designs auf C++

Letzte Änderung:2004-11-21

Jede Klasse hat einen Namen und eventuelle Superklassen

Beispiel:

    class PostAdresse : public Adresse {
    ...
    };
  

Jede Klasse hat mindestens einen Konstruktor

• Alle Konstruktoren sind public
• Alle Attribute erhalten Initalwerte.
• Automatisch sind die Elemente der STL (string, list etc) initialisiert
• Erst die Konstruktoren der Superklasse aufrufen, dann die Attibute in der Reihenfolge initialisieren.
• Es sollte auch einen Konstruktor ohne Argumente geben (Default Konstruktor) der auch ein normaler Konstruktor sein kann, bei dem Alle Parameter default-Werte haben.

Beispiel:

        PostAdresse(
          string art="",
          string strasse="",
          string ort="",
          string plz="",
          string land=""
       )
       :Adresse(art), // Superklassenkonstruktor
        _strasse(strasse), //initialisiere Attribute
        _ort(ort),
        _plz(plz),
        _land(land) {
         // sonst nichts zu tun
       }

In diesem Fall ist das auch der Default-Konstruktor weil alle Argumente weggelassen werden können.

Jede Klasse hat genau einen Destruktor

• Der Destruktor ist virtuell.
• Alle Composita werden freigegeben (da fehlt noch einiges)

Beispiel:

       virtual ~PostAdresse() {}

Attribute

• sind immer privat und heissen mit _ am Anfang.

Beispiel:

           private:
             string _strasse;
             string _ort;
             string _plz;
             string _land;

Accessormethoden je Attribut

• Get-Methoden sind const (verändern nicht das Objekt)
• Get und Set-Methoden sind virtual.

Beispiel

        public: 
           virtual string ort() const { return _ort; }
           virtual void setOrt(string ort) { _ort=ort; }

Dateinamen für die Deklaration

• Alle Klassen werden in einem h-File names klasse.h deklariert.
  Das File beginnt mit:

             #ifndef __KLASSE_H__
             #define __KLASSE_H__ // damit wird multiple Inclusion verhindert
  
             #incude <string>  // alle möglichen Utility-Klassen,
             #incude <list>    // die benötigt werden
     
             #include "superklasse.h" // Die Klasse(n) von der abgeleitet wird
  
             class Class : public Superclass {
  
        

• und endet mit:
  

  
             };
  
             #endif
        

Assoziationen

• Assoziationen werden je nach Typ:
  mit Listen, Vectoren, Maps, Arrays, Pointern etc. implemetiert. z.B eine *-Assoziation (wie zwischen Kontakt und Adresse) mit list<Adresse*> in Kontakt. Beispiel:

         typedef list<Adresse*> AdressenListe;
         ...
   
            private:
              AdressenListe _adressen;  //die eigenliche Liste
            public:
              void addAdresse(Adresse *adresse) {
                _adressen.push_front(adresse); // Adresse hinzufügen
              }
              void removeAdresse(Adresse *adresse) {
                _adressen.remove(adresse);     // Adresse entfernen
              }
              const AdressenListe* adressen() const {
                return &_adressen;             // Adressen zum iterieren holen
              }
     

Methoden

• Kurze triviale Methoden werden inline (in der Deklaration) implementiert. Siehe Accessormethoden.
• Kompliziertere Methoden stehen in "klasse.cpp" Beispiel:
  (postadresse.c)

   
             #include <cstdio>  // Utility includes
             #include "postadresse.h" // Declaration der Klasse
  
             void PostAdresse::debug() const {
               printf("PostAdresse(%s):%s %s %s %s\n",
     art().c_str(),strasse().c_str(),ort().c_str(),plz().c_str(),land().c_str());
             }
  
      

Bezeichner

• Bezeichner sind in unserem Projekt in englisch. (Ausnahmen kommen vor)
• Klassennamen sind groß geschrieben und Wortanfänge gekennzeichnet.
  Beispiel:PostAdresse
• Attribute sind kleingeschrieben und beginnen zusätzlich mit "_"
  Beispiel:_strasse
• Methoden sind kleingeschrieben
  Beispiel:debug()
• Acessor-Methoden sind attributname() zum Lesen und setAttributname zum Setzen
  Beispiel:setStrasse(), strasse()