Vortrag Code-Dokumentation

Präsentation zum Thema: "Vortrag Code-Dokumentation"—  Präsentation transkript:

1 Vortrag Code-Dokumentation
Eine Einführung in Doxygen und Sandcastle Gunter Nagel,

2 Inhalt Vergleich von Doxygen und Sandcastle
Kurze Einführung in Doxygen Einführung in Sandcastle

3 Vergleich von Doxygen und Sandcastle
Unterstützt sehr viele Sprachen Kann Vererbung grafisch darstellen Viele verschiedene Ausgabeformate Auf viele Plattformen und Betriebssysteme portiert Sandcastle Erzeugte Dokumentation sieht aus wie MSDN Sehr gute Integration in .Net-Framework

4 Kurze Einführung in Doxygen
Funktionsweise von Doxygen Doxygen parst den gesamten Quelltext Doxygen erstellt aus Klassendeklarationen und Methodendeklarationen grundlegende Dateien Doxygen fügt spezielle Kommentare in diese Dateien ein. Konfiguration dieses Prozesses erfolgt über die projektweite Konfigurationsdatei Doxyfile.

5 Aufbau der Doxygenkommentare
Doxygen versteht unter Anderem folgende Kommentartypen: Doc++-Kommentare XML-Kommentare aus .Net (siehe Codebeispiel)

6 Wie benutzt man Doxygen
Per Hand: Erstellung des Doxyfile Aufruf von Doxygen.exe Doxygen-Wizard Konfiguration des Projektes Erstellung der Dokumentations-Dateien

7 Ergebnisse von Doxygen
Beispiele aus: Xerces-Dokumentation Qt-Dokumentation Links: Doxygen

8 Einführung in Sandcastle
Funktionsweise von Sandcastle Projekteinstellungen im Visual Studio Sandcastle GUI XML-Kommentare

9 Funktionsweise von Sandcastle
Visual Studio erstellt auf Wunsch beim Compilieren XML-Kommentar-Dateien Sandcastle parst XML-Kommentar-Dateien Sandcastle erstellt daraus XML-Dateien Sandcastle erzeugt dann via XSLT neue Dateien, deren Format und Aussehen von den Settings abhängen

10 Konfiguration des Visual Studio
Projektkonfiguration: XML-Kommentar-Datei erstellen

11 Sandcastle GUI

12 XML Kommentare Kommentar für eine Zusammenfassung:
<summary>Die Zusammenfassung</summary> Kommentar für ein Parameter: <param name='name'>Description.</param> Kommentar für den Rückgabewert: <returns>Rückgabewertbeschreibung</returns> Kommentar für eine Bemerkung: <remark>Die Bemerkung.</remark>

13 XML-Kommentare 2 Kommentar für einen Absatz
<para>Inhalt des Absatzes</para> Kommentar für ein sehr kurzes Code-Beispiel im Fließtext <c>Das Code-Beispiel</c> Kommentar zum Verlinken von einem Parameter auf die ausführliche Beschreibung <paramref>name=“Parametername“</ paramref >

14 XML Kommentare 3 Verlinkung auf ein anderes Dokument für z.B. eine Klassenbeschreibung aus der MSDN <see cref=“Name“/> Kommentar für eine Exception, die die Klasse wirft <exception cref=“Exceptionklasse“></exception> Kommentar für ein längeres Code-Beispiel, meist umgeben von <example> <code>Beispielcode</>

15 XML-Kommentare 4 Kommentar für ein Beispiel, meist in Verbindung mit <code> <example>Das Beispiel</example>

16 Sandcastle-Links Sandcastle Sandcastle Helpfile Builder