Kleine Helfer

iPhone-Apps mit Doxygen effizient dokumentieren

Diego Wyllie hat Wirtschaftsinformatik an der TU München studiert und verbringt als Softwareentwickler und Fachautor viel Zeit mit Schreiben – entweder Programmcode für Web- und Mobile-Anwendungen oder Fachartikel rund um Softwarethemen.
Wer nach einem einfachen und effizienten Weg sucht, iPhone-Anwendungen zu dokumentieren, der dürfte bei dem quelloffenen und kostenlosen Werkzeug "Doxygen” fündig werden.
Aus formatierten Code-Kommentaren generiert Doxygen ähnlich wie JavaDoc eine übersichtliche Code-Dokumentation im Html-Format - inklusive Vererbungsdiagramme.
Aus formatierten Code-Kommentaren generiert Doxygen ähnlich wie JavaDoc eine übersichtliche Code-Dokumentation im Html-Format - inklusive Vererbungsdiagramme.

Native iOS-Anwendungen für iPhone, iPod Touch und iPad basieren auf der objektorientierten Programmiersprache Objective-C. Anders als Java mit "JavaDoc” verfügt Objective-C leider über kein Standard-Tool zur Dokumentation des Quellcodes. Wenn iOS-Entwickler Referenzdokumente für ihre Projekte automatisch erstellen möchten, müssen sie sich also selber darum kümmern, ein passendes Werkzeug zu finden. Eine interessante Lösung bietet hier Apple selbst mit der Open-Source-Software "HeaderDoc”. Sehr beliebt unter Objective-C-Programmieren ist aber vor allem Doxygen.

Durch formatierte Kommentare im Quelltext können Entwickler wie üblich Erläuterungen zu Klassen, Attributen und Methoden definieren, aus denen das für Mac, Linux und Windows erhältliche Programm die Dokumentation automatisch generiert. Außerdem ist es möglich, Projektübersichten, Zusammenfassungen und sogar Klassen- und Vererbungsdiagramme zu erzeugen. Neben Objective-C unterstützt Doxygen weitere Hochsprachen wie C, C++, Python, Fortran oder auch Java. Zu den unterstützten Ausgabeformaten gehören unter anderem Html, LaTeX, XML und PDF.

Mit Hilfe eines mitgelieferten GUI-Editors kann die Erstellung der Dokumentation einfach konfiguriert und gesteuert werden. Wer schnell Resultate sehen möchte, der kann den integrierten Dokumentations-Wizard verwenden. Hier genügen wenige Angaben wie Projektordner und Ausgabeformat. Ansonsten bietet das Programm einen Expertenmodus an, in dem sich sämtliche Einstellungen des Dokumentationsprozesses nach eigenen Vorstellungen anpassen lassen. Ferner kann das Tool in Xcode, Apples eigene Entwicklungsumgebung, integriert werden. Wie das geht, erklärt die Firma aus Cupertino in einem ausführlichen Online-Tutorial.

CW-Fazit

Doxygen hat sich unter Mac-Entwicklern längst einen guten Namen gemacht. Aufgrund seiner einfachen Bedienung und der Integrationsfähigkeit mit Xcode eignet es sich optimal für die Dokumentation von iOS- und Mac-Applikationen. (ph)