Programmierrichtlinien für C - 7

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

Aufbau von Include Dateien

  • Dateikommentar
  • Include-Anweisungen (zuerst <> dann "")
  • Makros, Defines und Konstanten
  • Typdeklaration für Datentypen
  • Deklarationen von Funktionsprototypen
    •   Beispiel:  
    /*------------------------------------------------------------------------------
    * Höhere Technische Bundeslehranstalt STEYR
    * Fachrichtung Elektronik - Ausbildungszweig Informatik
    *-------------------------------------------------------------------------------
    * Modul : Modulname
    * Erstautor: Nachname Vorname
    * Klasse : Klasse/Jahrgang
    * Datum : Erstellungsdatum
    *-------------------------------------------------------------------------------
    * Modulbeschreibung:
    * Hier beginnend
    * ...
    *-------------------------------------------------------------------------------
    */
    #ifndef _Modulname_H
    #define _Modulname_H

    #include <...>
    #include "..."
    /*------------------------------------------------------------------------------
    * Makros, Defines
    */
    #define ...

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

    /*------------------------------------------------------------------------------
    * Functions
    */

    /*------------------------------------------------------------------------------
    * Funktion mit kommentierten Parametern
    * IN: par1 Kommentar1
    * par2 Kommentar2
    * INOUT: par3 Kommentar3
    * RETURN:
    */
    void Function(int par1, int par2, int par3);
    ...

    #endif /* _Modulname_H */

    < Zurück | Vorwärts | Inhalt >