Header Beispiel für C: Unterschied zwischen den Versionen

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(6 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
== Einleitung ==
== Einleitung ==
Jeder quelltext sollte über einen Header verfügen, um folgenden inhalte zu vermittel:
Jeder Quelltext sollte über einen Header verfügen, um folgenden Inhalte zu vermitteln:
* Urheber/in
* Urheber/in
* Datum, Datum der letzten Änderung
* Datum, Datum der letzten Änderung
Zeile 8: Zeile 8:
* Notwendige Hardware
* Notwendige Hardware
* Notwendige Dateien
* Notwendige Dateien
* ggf. Hinweis
* ggf. Hinweis (Anschlussbeschreibung, Voraussetzungen,...)
<code> <source line lang="C" style="font-size:medium">//*****************************************************************************
Der Header informiert über die Urheberschaft der Software.
<code><source line lang="C" style="font-size:medium">//*****************************************************************************
// Modul          : DemoEEPROM.ino                                          *
// Modul          : DemoEEPROM.ino                                          *
//                                                                            *
//                                                                            *
Zeile 28: Zeile 29:
//          Größe ATmega328: 1 kByte
//          Größe ATmega328: 1 kByte
//*****************************************************************************
//*****************************************************************************
</source>
</source>
</code>
</code>

Aktuelle Version vom 28. Dezember 2022, 09:28 Uhr

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
//*****************************************************************************