vortrag code dokumentation l.
Download
Skip this Video
Download Presentation
Vortrag Code-Dokumentation

Loading in 2 Seconds...

play fullscreen
1 / 16

Vortrag Code-Dokumentation - PowerPoint PPT Presentation


  • 174 Views
  • Uploaded on

Vortrag Code-Dokumentation. Eine Einführung in Doxygen und Sandcastle Gunter Nagel, 21.04.2008. Inhalt. Vergleich von Doxygen und Sandcastle Kurze Einführung in Doxygen Einführung in Sandcastle. Doxygen Unterstützt sehr viele Sprachen Kann Vererbung grafisch darstellen

loader
I am the owner, or an agent authorized to act on behalf of the owner, of the copyrighted work described.
capcha
Download Presentation

PowerPoint Slideshow about 'Vortrag Code-Dokumentation' - chipo


Download Now An Image/Link below is provided (as is) to download presentation

Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -
Presentation Transcript
vortrag code dokumentation

Vortrag Code-Dokumentation

Eine Einführung in

Doxygen und Sandcastle

Gunter Nagel, 21.04.2008

inhalt
Inhalt
  • Vergleich von Doxygen und Sandcastle
  • Kurze Einführung in Doxygen
  • Einführung in Sandcastle
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

Vergleich von Doxygen und Sandcastle
kurze einf hrung in doxygen
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.
aufbau der doxygenkommentare
Aufbau der Doxygenkommentare
  • Doxygen versteht unter Anderem folgende Kommentartypen:
    • Doc++-Kommentare
    • XML-Kommentare aus .Net

(siehe Codebeispiel)

wie benutzt man doxygen
Wie benutzt man Doxygen
  • Per Hand:
    • Erstellung des Doxyfile
    • Aufruf von Doxygen.exe
  • Doxygen-Wizard
    • Konfiguration des Projektes
    • Erstellung der Dokumentations-Dateien
ergebnisse von doxygen
Ergebnisse von Doxygen
  • Beispiele aus:
    • Xerces-Dokumentation
    • Qt-Dokumentation
  • Links:
    • Doxygen
einf hrung in sandcastle
Einführung in Sandcastle
  • Funktionsweise von Sandcastle
  • Projekteinstellungen im Visual Studio
  • Sandcastle GUI
  • XML-Kommentare
funktionsweise von sandcastle
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
konfiguration des visual studio
Konfiguration des Visual Studio
  • Projektkonfiguration:
    • XML-Kommentar-Datei erstellen
xml kommentare
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>

xml kommentare 2
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 >

xml kommentare 3
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</>

xml kommentare 4
XML-Kommentare 4
  • Kommentar für ein Beispiel, meist in Verbindung mit <code>

<example>Das Beispiel</example>

sandcastle links
Sandcastle-Links
  • Sandcastle
  • Sandcastle Helpfile Builder
  • http://www.codeproject.com/KB/dotnet/ccnetsandcastle.aspx