GISELA
Programming Conventions

• Klassennamen beginnen mit einem Großbuchstaben
• Funktionsnamen beginnen mit einem Kleinbuchstaben
• Variablennamen beginnen mit einem Kleinbuchstaben, es sei denn, sie bestehen aus nur einem Buchstaben, z.B. L für eine Liste oder G für einen Graphen
• Aussagekräftige, kennzeichnende Bezeichner wählen
• Alle vom Projekt eingeführten Namen haben als Präfix pp_
• Für jede Klasse ein eigenes File
• Jedes File enthält im Kopf (d.h., den obersten Zeilen) Name, Autor und Versionsnummer

  // file     : <vollstaendiger Filename>
  // author   : <original Autor>
  // version  : <Versionsnummer>
  

  und am Ende die Historie

  /*
  <aktuelle V.>  <Datum>     <Name des Modifizierenden> 
  - <Aenderung>
  - <Aenderung>
  - <Aenderung>
  - <Aenderung>
  
  <Version>      <Datum>     <Name des Modifizierenden> 
  - <Aenderung>
  - <Aenderung>
  
  <Version>      <Datum>     <Name des Modifizierenden> 
  - <Aenderung>
  */
  

• Directory <GISELAROOT> hat ein src directory, das alle source files enthält, sowie ein directory include/GISELA, das die header files enthält. Include eines GISELA files sieht also so aus:

  #include <GISELA/name_des_files.h>
  

• Zur Dokumentation benuzten wir doc++

  /// <einzeilige Dokumentation>
  

  oder

  /**
  <mehrzeilige Dokumentation>
  */
  

  jeweils vor Beginn einer Klassendefinition oder Funktionsdefinition/deklaration.
• Eine Klassendefinition beginnt mit den public member functions und member data (dem für den Benuzter der Klasse wichtigen und einzig interessanten Teil. Es folgen eventuell friend Deklarationen und Definitionen. Die private member functions und member data bilden das Ende der Klassendefinition.
• Programming by contract: Pre- und Postconditions checken, assertions verwenden
• Klammerungsstil konsistent einsetzen (nur ein Stil pro file - emacs hilft dabei)