6.5Dokumentation der Programmierung49

Ein integraler Bestandteil jedes Softwareprogramms ist eine geeignete entwicklungsbegleitende Dokumentation. Eine gute, qualitativ hochwertige Dokumentation sollte dabei die folgenden Angaben beinhalten:

  • Kurzbeschreibung des Programms
  • Verwaltungsinformationen
  • Kommentierung des Quellcodes

Dabei werden die ersten beiden Angaben oftmals in einem Programmvorspann, dem sogenannten Header, zusammengefasst:

  • Name des Programms: möglichst prägnant und eindeutig
  • Aufgabe: kurze Beschreibung des Programms
  • Zeit- und Speicherkomplexität des Programms
  • Name der Programmautoren
  • Versionsnummer und Datum
  • Bearbeitungsstand des Programms: zum Beispiel »geplant«, »in Bearbeitung«, »vorgelegt«, »akzeptiert«

Zudem muss auch ...

Get Mobile App Engineering now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial