Programmierrichtlinien für C - 8

< Zurück | Vorwärts | Inhalt >
(DI Wittner Michael)

Aufbau von Implementierungs-Dateien

  1. Dateikommentar
  2. Include-Anweisungen (zuerst <> dann "")
  3. Makros, Defines und Konstanten
  4. Typdeklarationen für private Datentypen
  5. Deklarationen von privaten Funktionsprototypen
  6. Definition der öffentlichen Daten
  7. Definition der privaten Daten
Beispiel:

/*------------------------------------------------------------------------------
* Höhere Technische Bundeslehranstalt STEYR
* Fachrichtung Elektronik - Ausbildungszweig Informatik
*-------------------------------------------------------------------------------
* Modul : Modulname
* Erstautor: Nachname Vorname
* Klasse : Klasse/Jahrgang
* Datum : Erstellungsdatum
*-------------------------------------------------------------------------------
* Modulbeschreibung:
* Hier beginnend
* ...
*-------------------------------------------------------------------------------
*/

#include <...>
#include "..."

/*------------------------------------------------------------------------------
* Makros, Defines
*/
#define ...

/*------------------------------------------------------------------------------
* Typedefs
*/
enum ...
typedef ...
struct ...

/*------------------------------------------------------------------------------
* Funktion mit kommentierten Parametern für private Funktionen
* IN: par1 Kommentar1
* par2 Kommentar2
* INOUT: par3 Kommentar3
* RETURN:
*/
static void Function(int par1, int par2, int par3);

/*------------------------------------------------------------------------------
* Funktion mit unkommentierten Parametern
*/
void Function(int par1,int par2, int par3){
int i, j, k; /* lokale Variablen */
}



< Zurück | Vorwärts | Inhalt >