Java Quellcode parsen

[chilla]

Grüß euch.

Ich arbeite gerade an einem relativ großen Projekt , dessen Quellcode zum Großteil gut dokumentiert(javadoc!) ist. Nun möchte ich vor der Abnahme natürlich auch die paar Methoden bzw. Typen ausdokumentieren die noch fehlen.

Bei unmengen von Klassen ist das raussuchen der Lücken aber natürlich recht aufwendig.

Deswegen hab ich mir überlegt ein Tool zu schreiben welches erkennt ob eine Methode/Typ schon mit Javadoc dokumentiert sind.
Das könnte dann in Richtung eines Eclipse_plugins gehen wodurch man dann bequem alle nicht dokumentierten Methoden/Typen abrufen kann. (In etwa wie das Search Plugin, wo man dann von Treffer zu Treffer springen kann)

Soweit sogut, nur möchte ich das Rad nicht unbedingt neu erfinden.
Deswegen:

Kennt jemand so ein Tool? vielleicht bin ich ja nicht der erste der auf solch eine Idee kommt 😉

Ansonsten würde mich eben, wie der Titel schon sagt, interessieren ob es eine Bibliothek gibt die Javafiles parsed und dabei natürlich das Erkennen von Methoden,Typen,Fields etc. unterstützt.??

Dadurch würde mir natürlich viel Entwicklungsarbeit abgenommen werden. Denn ganz trivial erscheint mir solch eine parseApi nicht gerade 😉

Hoffe mir kann hier jemand helfen.

mfg, chl

 

[Atze]

hm, garkeine schlechte idee!
ich weiß nicht obs sowas schon gibt.
aber ausprobieren / nutzen würde ich es schon gern

falls du es irgendwann mal fertig hast, bzw was findest, her damit! 🙂

 

[tfa]

http://checkstyle.sourceforge.net/config_javadoc.html

 

[chilla]

Danke, das sieht schon sehr nach dem aus was ich will.
Werd ich mir am Wochenende mal zu Gemüte ziehen.


Aber gibts denn nun eine Bibliothek zum Quellcode parsen?? 😉

 

[Yzebär]

Eclipse erkennt selbst, ob eine Methode Javadocs hat oder nicht bzw. ob der Kommentar vollständig ist (d.h. ob auch alle Parameter kommentiert sind). Man muß nur unter Preferences/Java/Compiler/Javadoc einstellen, daß man gern Warnings oder Errors bekommen möchte, wenn die Javadoc-Kommentare fehlen oder unvollständig sind.

 

[Wildcard]

Aber gibts denn nun eine Bibliothek zum Quellcode parsen?? 😉

Wenn du sowieso schon über ein Eclipse PlugIn nachdenkst:
Eclipse bringt doch alles mit. Du kannst die ICompilationUnit von jdt verwenden und hast ein vollständiges Objektmodell der Java Klassen.

 

[Atze]

ui, was man nicht alles so dazulernt 🙂

 

[Guest]

Aber gibts denn nun eine Bibliothek zum Quellcode parsen?? 😉

Wenn du sowieso schon über ein Eclipse PlugIn nachdenkst:
Eclipse bringt doch alles mit. Du kannst die ICompilationUnit von jdt verwenden und hast ein vollständiges Objektmodell der Java Klassen.

&&

Eclipse erkennt selbst, ob eine Methode Javadocs hat oder nicht bzw. ob der Kommentar vollständig ist (d.h. ob auch alle Parameter kommentiert sind). Man muß nur unter Preferences/Java/Compiler/Javadoc einstellen, daß man gern Warnings oder Errors bekommen möchte, wenn die Javadoc-Kommentare fehlen oder unvollständig sind.

das wird ja immer besser leute !!

großen dank für diese infos und schönes wochenende 😉

mfg, chl

 

[Tobias]

Die Eclipse-Einstellungen sind tatsächlich sehr hilfreich. Aber gibt es da auch eine Möglichkeit, das irgendwie noch genauer ein zu grenzen? Zum Beispiel möchte ich meine Aspekte nicht von Eclipse auf Dokumentation überprüfen lassen (weil Eclipse da nämlich Mist erzählt, zum Beispiel verlangt es einen @return-Tag bei Pointcut-Definitionen). Und auch meine Unit-Tests müssen nicht dokumentiert werden. Ich bräuchte also idealerweise Einschränkungen nach Dateiendung / Typ oder per Regex o.ä. nach Namen ... Kennt ihr sowas oder liefert Eclipse das irgendwo mit?

mpG
Tobias