Doxygen ist das de facto Standardwerkzeug zur Generierung von Dokumentationen aus annotierten C++-Quellen, unterstützt jedoch auch andere beliebte Programmiersprachen wie C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft und UNO/OpenOffice-Varianten), Fortran, VHDL, Tcl und bis zu einem gewissen Grad D.
Doxygen kann Ihnen auf drei Arten helfen:
- Es kann einen Online-Dokumentationsbrowser (in HTML) und/oder ein Offline-Referenzhandbuch (in $mbox{LaTeX}$) aus einer Menge dokumentierter Quelldateien generieren. Es gibt auch Unterstützung für die Generierung von Ausgaben in RTF (MS-Word), PostScript, hyperverlinktem PDF, komprimiertem HTML und Unix-Man-Seiten. Die Dokumentation wird direkt aus den Quellen extrahiert, was es viel einfacher macht, die Dokumentation konsistent mit dem Quellcode zu halten.
- Sie können Doxygen so konfigurieren, dass es die Code-Struktur aus undokumentierten Quelldateien extrahiert. Dies ist sehr nützlich, um sich schnell in großen Quellverteilungen zurechtzufinden. Doxygen kann auch die Beziehungen zwischen den verschiedenen Elementen durch Mittel von Include-Abhängigkeitsdiagrammen, Vererbungsdiagrammen und Kollaborationsdiagrammen visualisieren, die alle automatisch generiert werden.
- Sie können Doxygen auch zur Erstellung normaler Dokumentationen verwenden (wie ich es für das Doxygen-Benutzerhandbuch und die Website getan habe).
Hinweis: Während die Software als kostenlos eingestuft wird, ist sie tatsächlich Donationware. Bitte ziehen Sie in Betracht, eine Spende zu machen, um die Entwicklung zu unterstützen.