Gibt es Tools zum automatischen Aktualisieren von Javadoc?

Question

Ich arbeite an einer Code-Basis, die ... chaotisch ist. Ein Aspekt dieser Unordnung ist, dass wir eine Menge Methoden haben, deren Signaturen nicht mehr mit dem zugehörigen Javadoc übereinstimmen. Zum Beispiel:

/** 
* 
* @ param foo 
*/ 
public void doFoo(int bar) {... 

Ich bin kein Fan von erzeugt Javadoc (wie es fast immer wertlos ist), aber ich konnte wirklich ein Tool verwenden, die durch unseren Code gehen, finden Fälle so, und:

1. entfernen Sie die javadoc für die "foo" param
2. javadoc für die "bar" param hinzufügen (aber nur eine leere, nicht automatisch generiert doc oder irgendetwas)

Ist ein solches Tool gibt es? Wenn nicht, existiert ein Werkzeug, das nur # 1 tut? Sogar so viel würde die Menge der Warnungen, die wir in unseren Builds bekommen, erheblich reduzieren. Vielen Dank.

Answer 1

NetBeans hat ein Werkzeug dafür. Es tut genau das, was du fragst.

Sie können entweder klicken Sie auf das Tools Menü, dann Analyze Javadocs von oben, oder Rechtsklick auf eine Datei und klicken Sie Tools, dann Analyze Javadocs.

Das gibt Ihnen dann eine Liste aller Probleme, die es mit Ihren Javadocs findet, mit einer Option, es zu beheben. Es ermöglicht Ihnen, ein einzelnes Problem in einer Methode zu beheben, die Javadocs für die Methode, für die Datei, für das Paket oder für das gesamte Projekt zu beheben.

Answer 2

Eine Lösung, wenn Sie Eclipse verwenden, gehen Sie zu Window -> Preferences -> Java -> Compiler -> Javadoc und dann setzen Sie die Variable 'Malformed Javadoc Kommentare' auf Warnung oder Fehler.

Sie können dann zur Problemansicht gehen Window -> Show View -> Problems und dann auf jeden Fehler mit der rechten Maustaste und wählen Sie "Quick Fix".

Answer 3

Ich habe keine andere als DocCheck versucht, aber this somewhat-dated page on Sun's site listet mehrere Drittanbieter-Doclets, von denen einige vorgeben, Javadoc in Ihre Quelle einzufügen. Von diesen können Sie einen Blick auf Doc-o-Matic, JRefactory Pretty Printer und ACTOS Auto Commentator for Java werfen. Auch hier habe ich noch nichts ausprobiert, aber es ist ein guter Anfang.