Header Beispiel für C

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen

Einleitung

Jeder Quelltext sollte über einen Header verfügen, um folgenden Inhalte zu vermitteln:

  • Urheber/in
  • Datum, Datum der letzten Änderung
  • Modulname
  • Funktion
  • Version der IDE
  • Notwendige Hardware
  • Notwendige Dateien
  • ggf. Hinweis (Anschlussbeschreibung, Voraussetzungen,...)

Der Header informiert über die Urheberschaft der Software.

//*****************************************************************************
// Modul           : DemoEEPROM.ino                                           *
//                                                                            *
// Datum           : 09.12.2022                                               *
//                                                                            *
// Funktion        : Daten im EEPROM speichern                                *
//                                                                            *
// Implementation  : Arduino IDE 2.0.3                                        *
//                                                                            *
// Hardware        : Arduino UNO R3                                           *
//                                                                            *
// Author          : (c) 2022, Dr. Ulrich Schnedier                           *
//                                                                            *
// Letzte Änderung : 09.12.2022                                               *
//                                                                            *
//*****************************************************************************
// ACHTUNG: Anzahl der garantierten Schreib- und Lesezyklen: 100 000
//          Größe ATmega328: 1 kByte
//*****************************************************************************