O'Reilly logo

Mobile App Engineering by Guy Vollmer

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

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 ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required