Doxygen

Aus THM-Wiki
Wechseln zu: Navigation, Suche

Doxygen ist ein bekanntes Software-Dokumentationstool, mit dem sich einfach eine Codedokumentation in vielfältigen Formaten (u.a. HTML und LaTeX) erstellen lässt.

Um eine Dokumentation erstellen zu können muss der Quellcode, vor allem Klassen, Attribute und Methoden, mit bestimmten Tags versehen werden.

Folgende Tags können hierbei angegeben werden:

  • bei Klassen: @version, @author, @todo
  • bei Attributen: @todo
  • bei Methoden: @param, @return, @todo

Beispiel für dokumentierten Code

Um die Art und Weise der Dokumentation im Code zu verdeutlichen, hier ein kleines Beispiel:

/// Kurzbeschreibung der Klasse...
/**
 * Eine kleine Klasse, macht nichts
 * @version 0.1
 * @author Stefan Student <stefan.student@abc.de>
 * @todo Diese Klasse muss dringend refaktorisiert werden!
 */

class Klasse {

/// Die ID ...
private $id; 

/// Kurzbeschreibung der Methode ...
/**
 * Eine nette Methode
 * @param id Die ID ....
 * @param time Die Zeit ...
 * @return Das ist der Rueckgabewert
 */
 public function myNiceMethod( $id, $time ) {
     ...
     return "Rueckgabe";
 }

}

Erstellen der Dokumentation

Um nun die Dokumentation erstellen zu können muss Doxygen den Quellcode auf die angegebenen Tags durchsuchen. Hierzu bietet sich die Verwendung von Doxygen-Wizard an, mit dessen Hilfe es auch möglich ist die entsprechende Konfigurationsdatei GUI-gestützt zu erstellen.

Doxygen-wizard.png

Dieses Tool liegt vielen Linux-Distributionen bei und ist auch für Windows erhältlich.