Audiolab.de

doxygen

Um in ein komplexes Projekt neu einzusteigen, ist eine Dokumentation oder ein Design-Dokument unabdingbar. Oft ist das zugrunde gelegte Datenmodell nur sehr schwer aus dem Quellcode zu extrahieren, ebenso die Klassen-Hierarchie, die sich nur mit viel Mühe aus dem Code herauslesen lässt. Ebenso steht man vor dem Problem, dass neue Entwicker Änderungen in der Klassenhierarchie vornehmen und die Dokumentation im Design-Dokument vergessen werden. Hierfür wäre eine automatisch erstellte Dokumentation sehr praktisch, genau an diesem Punkt setzt doxygen an.

doxygen ist ein Tool, mit dem man lesbare Dokumentationen für C, C++, Java, IDL und C# automatisch erstellen lassen kann. doxygen steht unter der GPL-Lizenz, welche dem Anwender die Möglichkeit bietet, direkt den Quellcode bearbeiten und abändern zu können. doxygen wird ursprünglich unter Linux entwickelt, aber man kann es auch auf Windows-Systemen einsetzen.