Die Präsentation wird geladen. Bitte warten

Die Präsentation wird geladen. Bitte warten

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

Ähnliche Präsentationen


Präsentation zum Thema: "Vortrag Code- Dokumentation Eine Einführung in Doxygen und Sandcastle Gunter Nagel, 21.04.2008."—  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 Doxygen 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 parst den gesamten Quelltext Doxygen erstellt aus Klassendeklarationen und Methodendeklarationen grundlegende Dateien Doxygen erstellt aus Klassendeklarationen und Methodendeklarationen grundlegende Dateien Doxygen fügt spezielle Kommentare in diese Dateien ein. Doxygen fügt spezielle Kommentare in diese Dateien ein. Konfiguration dieses Prozesses erfolgt über die projektweite Konfigurationsdatei Doxyfile. Konfiguration dieses Prozesses erfolgt über die projektweite Konfigurationsdatei Doxyfile.

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

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

7 Ergebnisse von Doxygen Beispiele aus: Xerces-Dokumentation Xerces-Dokumentation Xerces-Dokumentation Qt-Dokumentation Qt-Dokumentation Qt-Dokumentation Links: Doxygen Doxygen 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 XML-Kommentar- Datei erstellen

11 Sandcastle GUI

12 XML Kommentare Kommentar für eine Zusammenfassung: Die Zusammenfassung Die Zusammenfassung Kommentar für ein Parameter: Description. Description. Kommentar für den Rückgabewert: Rückgabewertbeschreibung Kommentar für eine Bemerkung: Die Bemerkung. Die Bemerkung.

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

14 XML Kommentare 3 Verlinkung auf ein anderes Dokument für z.B. eine Klassenbeschreibung aus der MSDN Kommentar für eine Exception, die die Klasse wirft Kommentar für ein längeres Code-Beispiel, meist umgeben von Kommentar für ein längeres Code-Beispiel, meist umgeben von Beispielcode

15 XML-Kommentare 4 Kommentar für ein Beispiel, meist in Verbindung mit Kommentar für ein Beispiel, meist in Verbindung mit Das Beispiel Das Beispiel

16 Sandcastle-Links Sandcastle Helpfile Builder Sandcastle Helpfile Builder etsandcastle.aspx


Herunterladen ppt "Vortrag Code- Dokumentation Eine Einführung in Doxygen und Sandcastle Gunter Nagel, 21.04.2008."

Ähnliche Präsentationen


Google-Anzeigen