Welches Dokumentationswerkzeug für C++-Bibliotheken?



  • Hallo Community

    Ich möchte meine Bibliothek den Programmieranfängern im Projekt möglichst einfach benutzbar machen und will deshalb zusätzlich zu meinen vorbildlich dokumentierten Headern eine HTML-Dokumentation erstellen. Da es im Augenblick noch nicht allzu viele Klassen und Funktionen (in verschachtelten Namensräumen) sind, scheue ich den Aufwand nicht, die Kommentare, wenn nötig, dem ausgewählten Werkzeug anzupassen.

    Offenbar verwenden die besten mir bekannten Dokumentationen Doxygen in allen verschiedenen Varianten, es scheint mir als das flexibelste System. Was mir nicht gefällt ist das Standard-Design von Doxygen, das finde ich hässlich und umständlich.
    Ich bin jung und völlig vorbehaltlos und möchte auch einmalig etwas Zeit investieren, das Ding zu verstehen, was ich aber nicht möchte, ist, jedesmal erneut Stunden zu benötigen, das Design so anzupassen, dass es mir gefällt; diese Zeit verbringe ich lieber damit, die eigentlichen Schnittstellen zu verbessern. Und Alternativen gibt es zahlreiche (die englische Wikipedia hat eine riesige Liste davon), einige wie Natural Docs finde ich gar nicht mal so schlecht.
    Es geht mir nicht nur um die genannte Situation, ich will das Dokumentationswerkzeug auch später einmal wieder einsetzen, es soll universell, schick (verschiedene Designs zur Auswahl) und intuitiv für jeden benutzbar sein. Plattformunabhängigkeit wäre nicht schlecht, auf Linux sollte es auf jeden Fall laufen, schön wäre auch Windows. Mehrsprachigkeit muss nicht sein (wäre trotzdem ein Pluspunkt), C und C++ sollen aber auf jeden Fall unterstützt werden.

    Daher wollte ich euch fragen: Was verwendet ihr und welche Erfahrungen habt ihr damit gemacht? Welches hat eurer Meinung nach am meisten Zukunft, welches mögt ihr überhaupt nicht?

    Vielen Dank schon im Voraus!

    PS: Falls das besser in "Rund um die Programmierung" aufgehoben ist, bitte verschieben.



  • Das Design der von Doxygen generierten Seiten kannst du mit CSS-Stylesheets festlegen.

    Doxygen verwende ich selbst und finde es eigentlich nicht schlecht. Ein paar Dinge sind aber mühsam, und ich hasse den Mailinglist-Betrieb, um mit den Entwicklern in Kontakt zu treten.



  • Für andere Sprachen hatte ich mir auch mal http://www.doc-o-matic.de/ angeguckt. Für C++ gefällt mir doxygen aber besser. Meine Dokumentation muss nicht schön sondern funktionell sein.




Anmelden zum Antworten