Doxygen vs Javadoc [geschlossen]

Question

Ich bin gerade von einem Artikel in CACM realisiert, dass Doxygen mit Java arbeitet (und einige andere Sprachen) zu. Aber Java hat bereits das Javadoc-Tool. Kann jemand erklären, was die Vor- und Nachteile der beiden Ansätze sind? Sind sie sich gegenseitig ausschließen? Gibt es eine Maven-Plugin für Doxygen?

Answer 1

Doxygen hat eine Reihe von Features, die JavaDoc nicht bieten, z.B. die Klassendiagramme für die Hierarchien und die Zusammenarbeit Kontext, mehr Übersichtsseiten, optional Source-Code-Browsing (mit der Dokumentation vernetzten), zusätzliche Tag-Unterstützung wie @todo auf einer anderen Seite und es kann Ausgabe in TeX und PDF-Format erzeugen .Es können auch viele visuelle Anpassung.

Da Doxygen die Standard-JavaDoc-Tags unterstützt Sie Doxygen auf jedem Quellcode mit JavaDoc Kommentare darauf laufen können. Es kann oft sogar sinnvoll sein, auf Quellcode ohne JavaDoc zu laufen, da die Diagramme und Quellcode-Browsing helfen können, Code zu verstehen, auch ohne die Dokumentation. Und da das JavaDoc Werkzeug unbekannt Tags ignoriert können Sie sogar zusätzliche Doxygen-Tags verwenden, ohne JavaDoc Generation zu brechen.

Nach diesen Worten alles, was ich muss zugeben, dass ich nicht Doxygen für eine lange Zeit verwendet haben. Ich neige dazu, stark auf meinen IDE verlassen heute die gleiche Visualisierung zur Verfügung zu stellen und ich in der Regel nicht JavaDoc als HTML-Seiten lesen, aber die Quelldateien in meine IDE importieren, damit es JavaDoc Flyouts erzeugen kann, und ich kann die Definitionen springen. Das ist noch mächtiger als das, was Doxygen zu bieten hat. Wenn Sie Dokumentation außerhalb der IDE haben wollen und sind glücklich, nicht-Java Werkzeuge laufen dann Doxygen ist einen Versuch wert, da es keine Änderung an Ihrem Java-Code erforderlich ist.

Answer 2

Ich würde nur Doxygen mit Java verwenden, wenn Sie auf Java neu sind und Sie haben Doxygen bevor verwendet, die Lernkurve zu reduzieren Sie mit javadoc erleben würde. Wenn Sie Doxygen noch nicht verwendet haben, würde ich mit javadoc bleiben, da es speziell mit Java konzipiert wurde. Wenn Sie nicht entweder nicht kennen, und Sie arbeiten in C ++ (oder anderen Sprachen unterstützt), so viel wie Sie tun, Java, ist Doxygen eine gute Wahl, wie Sie in der Lage sein werden, es zu benutzen für beiden Sprachen.

Beide Werkzeuge sind einfach zu bedienen, mit einem ähnlichen Funktionsumfang. Beide haben Plugins (oder sind bereits eingebaut) für NetBeans und Eclipse macht es noch schneller doc zu erzeugen. Es gibt viele Überschneidungen im Kommentar Stil von jedem verwendet werden, aber sie sind nicht genau die gleiche, so dass es schwierig sein würde, um sie miteinander zu mischen (Sie die Details wissen müss < em> beide , alle Funktionen auszulassen, die auf die eine oder andere spezifisch sind). Ich habe es nie benutzt, aber es scheint ein Maven Plugin für Doxygen zu sein.

Answer 3

Ich mag die Tatsache, dass mit Doxygen, können Sie Klassendiagramme erhalten auf der gleichen Seite wie die Dokumentation angezeigt. Auch ich mag die Tatsache, dass es direkt auf den Quellcode verbindet, wenn nötig. Ich bin mir nicht bewusst, wenn javadoc diese Funktionen hat aber.

Answer 4

Ein großer Vorteil von JavaDocs ist, dass sie gerade arbeiten. Alles, was benötigt, um sie zu bauen und zu sehen ist, in dem JDK enthalten, die Sie bereits benötigen für die Erstellung Ihrer Programme installiert haben.

Doxygen, auf der anderen Seite kann ein Schmerz richtig einzurichten und zu erhalten zu arbeiten. aber wenn es richtig eingerichtet ist, sollte es in der Lage sein PDF-Dateien zu erzeugen, RTFs und DocBooks sowie HTML. Der HTML-Code ist nicht so gut, standardmäßig als JavaDocs organisiert, da die index.html eine leere Seite standardmäßig bringt. Auch Inline-Klassen und statische Elemente können spezielle Flags müssen in der Dokumentation enthalten sein, und wenn Sie ein PDF erstellen wollen, können Sie mit Ärger Ihrer Linux-Distribution zu tun haben nicht den benötigten pdflatex Befehl mit (zB Ubuntu / Mint gehabt hat Probleme vor kurzem) so, wenn Sie es einfach apt-get install und führen Sie einen Bildschirm vollen Fehler sogar mit einem einfachen Programm bekommen können. Im Vergleich zu der Leichtigkeit des Erhaltens javadoc automatisch, wenn Sie die API installiert hat, kann Doxygen Setup eine elende Erfahrung sein. Sobald Sie die Hürden zu überwinden, sollte es flexibler sein mit Projekten im Umgang mehr als nur Java beteiligt, though.