it-swarm.com.de

Javadoc-ähnliche Dokumentation für C++

Gibt es ähnliche Dokumentations-Generierungssysteme wie Javadoc für C++? Javadoc produziert Nizza-Ausgabe; Es wäre schön, wenn Sie so etwas in anderen Sprachen verwenden könnten. 

50
DHamrick

Es gibt verschiedene Tools, die wie JavaDoc für C++ funktionieren. Das beliebteste Tool ist wahrscheinlich doxygen . Es kann JavaDoc-artige Kommentare und auch mehrere Sprachen verarbeiten (z. B. C++, C, Java, Objective-C, Python, PHP, C #). Es hat eine ziemlich gute Unterstützung für die Anpassung des Stils der HTML-Ausgabe mit CSS (siehe die Liste users für Dokumentationen).

Bei der Auswahl des Dokumentationssystems ist es wichtig, sicherzustellen, dass Sie dies tun können

  • Dokumentieren Sie die Entitäten, an denen Sie interessiert sind. Möchten Sie das System anhand der Codestruktur oder einer anderen Modulabteilung dokumentieren.
  • Die Ausgabe wird wie gewünscht formatiert. Es ist vorzuziehen, wenn die Dokumentation zu Ihrem allgemeinen Projektstil passt.

Wir haben mit doxygen die Erfahrung gemacht, dass es ziemlich einfach einzurichten und zu verwenden ist, und die resultierende Ausgabe ist ziemlich einfach zu optimieren. Leider ist Doxygen nicht perfekt. In einigen Fällen müssen Macken oder Fehler behoben werden, bei denen der Doxygen-Parser zusammenbricht. Stellen Sie sicher, dass Sie Ihre generierte Dokumentation sorgfältig prüfen.

55
Zayenz

Sie können Javadoc nicht speziell verwenden, aber es gibt einige Tools, die das tun, was Sie wollen. Die meisten Menschen neigen dazu, Doxygen zu verwenden. Hier sind einige Links für Doxygen und Doc ++:

Doxygen
Doc ++

20
Ben Lakey

Es gibt Doxygen

11
Grant Limberg

Es gibt auch qdoc für QT-basierte C++ - Projekte. http://doc-snapshot.qt-project.org/qdoc

1
Yair

Ich beginne gerade damit, Sphinx für meine Python-Projekte zu verwenden. Die Startseite besagt "C/C++ wird auch bereits unterstützt".

Es verwendet ein leichtes Markup namens " reStructuredText ".

Ich habe es gerade für meine Python-Projekte verwendet und das Aussehen der Ausgabe gefällt mir sehr gut.

0
Dan H