Kurze Einführung in die Benutzung des Dokumentationswerkzeugs Doxygen

Größe: px

Ab Seite anzeigen:

Download "Kurze Einführung in die Benutzung des Dokumentationswerkzeugs Doxygen"

Karin Kaufman
vor 6 Jahren
Abrufe

1 Kurze Einführung in die Benutzung des Dokumentationswerkzeugs 2008

2 Gliederung 1 Zweck 2

3 Gliederung Zweck 1 Zweck 2

4 Zweck Zweck Erstellen einer übersichtlichen, zentralen Dokumentation im HTML-Format Überblick über den Aufbau des Programms Vermeidung von Redundanzen und Ungenauigkeiten

5 Zweck Zweck Erstellen einer übersichtlichen, zentralen Dokumentation im HTML-Format Überblick über den Aufbau des Programms Vermeidung von Redundanzen und Ungenauigkeiten

6 Zweck Zweck Erstellen einer übersichtlichen, zentralen Dokumentation im HTML-Format Überblick über den Aufbau des Programms Vermeidung von Redundanzen und Ungenauigkeiten

7 Gliederung 1 Zweck 2

8 Dateien Header (.h) Implementierungen (.cpp)

9 Dateien Header (.h) Implementierungen (.cpp)

10 Klassen Klassenname Klassenelemente (Dateitypen, Funktionen) Klassenhierarchie (Vererbung)

11 Klassen Klassenname Klassenelemente (Dateitypen, Funktionen) Klassenhierarchie (Vererbung)

12 Klassen Klassenname Klassenelemente (Dateitypen, Funktionen) Klassenhierarchie (Vererbung)

13 Funktionen Parameter Name Datentyp Bedeutung Typ des Rückgabewerts

14 Funktionen Parameter Name Datentyp Bedeutung Typ des Rückgabewerts

15 Funktionen Parameter Name Datentyp Bedeutung Typ des Rückgabewerts

16 Funktionen Parameter Name Datentyp Bedeutung Typ des Rückgabewerts

17 Funktionen Parameter Name Datentyp Bedeutung Typ des Rückgabewerts

18 Variablen Datentyp Bedeutung

19 Variablen Datentyp Bedeutung

20 Todo List Auflistung anstehender Arbeiten Referenz zur dazugehörigen Position im Code

21 Todo List Auflistung anstehender Arbeiten Referenz zur dazugehörigen Position im Code

22 Gliederung 1 Zweck 2

23 Code dokumentation Beschreibungen //! Kurzbeschreibung /*! Längere Beschreibung mit Zeilenumbrüchen */ int funktion(...) {} Hinweise Dokumentation beginnt mit //! bzw. /*!.. */ Dokumentationsblock direkt vor Deklaration der Klasse/Funktion/Variable lange Beschreibung für Details nutzen

24 Funktionen Parameter und Rückgabewert /*! Längere Beschreibung \param x1 Länge \param x1 Breite \return Flächeninhalt des Vierecks */ int funktion(int x1, int x2) {} Hinweise Dokumentation von Parametern und Rückgabewert sollte nur in trivialen Fällen weggelassen werden

25 nachträgliches Dokumentieren class A { private: //! Beschreibung vor Deklaration int x; }; int y; //!< Beschreibung hinter Deklaration Hinweise Dokumentation normalerweise vor Deklaration einer Variable < dient also zur nachträglichen Dokumentation

26 Todos /*! */ Längere Beschreibung \todo Fehlerausgaben implementieren \todo anderes Todo-Objekt, das sich \todo über mehrere Zeilen erstreckt Hinweise Todos in Beschreibung von Objekten einbetten Geben Hinweise auf noch zu implementierende Funktionen oder Verbesserungsvorschläge Werden von auf einer Todo-Liste aufgeführt

27 Übersichtliche, klare, strukturierte Dokumentation Effizientes Dokumentieren parallel zum Programmieren

28 Übersichtliche, klare, strukturierte Dokumentation Effizientes Dokumentieren parallel zum Programmieren

29 Anhang Web-Links Homepage:

Ähnliche Dokumente

Vorkurs C++ Programmierung

Vorkurs C++ Programmierung Klassen Letzte Stunde Speicherverwaltung automatische Speicherverwaltung auf dem Stack dynamische Speicherverwaltung auf dem Heap new/new[] und delete/delete[] Speicherklassen: