Wie ergibt ich den vollen Anrufdiagramm zu Dokumentationszwecken?

Question

Unser Team ist erforderlich, um jede Methode in unserem Code zu dokumentieren, und beschreiben Sie, was ein- und ausgeschaltet wird, und so.Ist es möglich, ein Dokument automatisch zu generieren, das eine vollständige Anrufhierarchiestruktur mit einer Funktion beginnt und an alle möglichen Anruferweiterungen unternimmt?Wie?Mit Eclipse, Frühling, Winterschlaf.Wir haben auch Zugang zu NetBeans, und alles andere, was helfen würde.

Ich weiß, dass es völlig unnötig ist, aber manchmal finden wir uns in diesen Situationen selbst und können nicht viel darüber tun: -).

Grundsätzlich brauche ich einen Java-Anrufgraphengenerator, denke ich, der Grund, warum ich nicht finden kann, ist, dass virtuelle Funktionen statische Analyse verhindern?

Answer 1

Ich empfehle dringend doxygen .

Sogar mit dem "unbehandelten" Code erzeugt es Anrufe Bäume, Klassenvererbungspläne und mehr als HTML.Wenn Sie ein paar speziell formatierte Kommentare hinzufügen (eine pro Klasse, Funktion, notleidbare Datenstruktur), können Sie viel mehr davon abrufen.

Schauen Sie sich das Beispiele und das riesige Liste der Projekte, die Doxygen verwenden.

Ich persönlich würde nichts anderes verwenden und darauf bestehen, dass jeder in meiner Firma geschriebene Kodex Doxygen verwendet.

edit: P.s doxygenis So nützlich, auch auf unkommentierter Code, dass es das erste Werkzeug ist, nach dem ich suche, wann ich den Legacy-Code eines anderen erble.Nichts anderes gibt mir so einen guten Überblick so schnell.

Answer 2

Es ist keine genaue Lösung für Ihr Problem, kaufen Sie, dass Sie die Doclet-API verwenden und Ihr eigenes Dokplet schreiben.Sie können mit ihren Argumenten und ihren Rückgabearten und vielem mehr auf Methoden zugreifen.Wenn Sie auf diese Weise gehen, können Sie auch die Kommentare der Methode zu Dokumentationszwecken ergreifen.