Wie intelligent Dokumentation in Eclipse zu beheben?

Question

In meinen C# -Tagen liebte ich die Verwendung einer Visual Studio-Erweiterung namens "GhostDoc". Nun, da ich ein Wesen bin, das als Java-Entwickler benutzt wird, benutze ich Eclipse. Ich kann leben, ohne eine Dokumentation haben zu können, aber etwas, was ich tun möchte, ist, meine Dokumentation intelligent zu "reparieren". Zum Beispiel, nehmen wir an, ich habe folgendes Verfahren:

/** 
* Gets a collection of {@link Foo} objects 
* @param bar The bar level 
* @param baz The bazziness 
*/ 
public Collection<Foo> getFoos(int bar, int baz) 
{ 
    // Do something cool 
} 

auf Später in der Entwicklung merke ich, dass es nützlich wäre, die Verbraucher meiner Methode zu ermöglichen, in einem qux Wert zu übergeben. Nicht nur das, aber es macht am meisten Sinn, es als den ersten Parameter zu haben. Auch ich werde die Methode meine super nützliche FooBarException werfen lassen. So, jetzt meine Methode sieht wie folgt aus:

/** 
* Gets a collection of {@link Foo} objects 
* @param bar The bar level 
* @param baz The bazziness 
*/ 
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException 
{ 
    // Do something cool 
} 

Sein ein guter Entwickler, ich möchte, dass meine Änderungen spiegelt sich in meinem JavaDoc. In GhostDoc konnte ich meine Dokumentkürzel-Taste drücken und es würde die neuen Sachen hinzufügen, ohne die alten Sachen zu stören. In Eclipse rendert es einen ganz neuen Satz von JavaDoc und ich muss eine Reihe von Copy Pasta machen. Wie kann ich automatisch den neuen @param, @exception und den fehlenden Parameter @returns in meinen JavaDoc einfügen, ohne den JavaDoc zu verlieren, den ich derzeit habe?

Answer 1

Nicht sicher, ob das folgende ist, was Sie ment, aber da eclipse seine eigene JavaDoc Validator hat, können Sie Warnungen/Fehler unter

Fenster kompilieren konfigurieren -> Einstellungen -> Java -> Compiler -> JavaDoc.

Mit der Aktivierung der fehlenden javadoc-Tags auf Ihre eigenen Bedürfnisse und der Einstellung der Warnstufe auf "warning" wird der Compiler Ihre Änderungen bemerken und Sie warnen, sobald sich Ihr Javadoc von Ihrer Methodensignatur unterscheidet. Um es zu beheben, bietet es einen Quickfix (STRG + 1) und Sie können wählen, alle fehlenden Tags hinzuzufügen. Diese Operation fügt die fehlenden Tags sogar an der richtigen Stelle hinzu, ohne mit Ihrem alten Kommentar zu verwirren.

Answer 2

Eclipse unterstützt "Code" -Komplett für JavaDoc auch. Sie müssen die hole-Anweisung nicht eingeben. Sie müssen nur "@p" eingeben und STRG + Leertaste wird den Rest für Sie ausdrucken. Oder noch besser, schreiben Sie einfach den Namen des Parameters, Code-Completion fügt den Rest hinzu.

Es ist nicht direkt eine Abkürzung, aber Sie können schneller das Javadoc als alles von Grund auf neu schreiben.

gleich für @t (@throw) @r (@return) und so weiter.

Bearbeiten, um Ihren Kommentar:

Sie können Check konfigurieren, für Ihre Klassen automatisch zu überprüfen. Checkstyle meldet, wenn Ihre Methode über einen nicht dokumentierten Parameter oder andere fehlende Parameter verfügt. Checkstyle kann auch prüfen, ob Ihr erster Satz mit einem '.' oder nicht. Sie können viele solcher Regeln von Hand.

Checkstyle fügt in Ihrem Java-Code-Editor und in Ihrer Problemansicht Problemmarkierungen hinzu. So können Sie problemlos Codezeilen mit Javadoc-Problemen finden.

Answer 3

Die Eingabe von/** oberhalb eines typischen Kommentars (gleiche Orte wie bei GhostDoc) vervollständigt automatisch eine Vorlage für den Kommentar.

Wenn Sie den Namen einer Variablen mithilfe der Umbenennungsfunktion (Umschalt + Alt + R) ändern, ändert Eclipse die Namen auch an den richtigen Stellen, vorausgesetzt, der Code wird kompiliert.

Dies beinhaltet und Kommentarlinks Sie haben

/** 
* 
* My funky method 
* 
* @param myThing 
*   myThing is of type {@link MyThingClass} 
*/ 
public void myMethod(MyThingClass myThing) {} 

gemacht Umbenennung entweder Mything oder MyThingClass mit Eclipse Umbenennung Funktionalität aktualisiert auch diese Verweise.

Ebenso wird die „Change Method Signature‘ Funktionalität mit zu Ihren Kommentare aktualisieren.

Grundsätzlich, wenn Sie überhaupt Refactoring, verwenden Sie das Refactoring-Menü (Shift + Alt + T).

Answer 4

Checkstyle wurde bereits erwähnt. Ich habe es versucht, aber es schien meine Eclipse stark zu verlangsamen (E4 juno though, das dafür bekannt ist, einige schlechte Verlangsamungen zu haben).

Google CodePro machte einen besseren Job, also benutze ich jetzt jetzt.

Und natürlich können Sie JavaDoc Warnungen aktivieren.

Answer 5

http://jautodoc.sourceforge.net/ funktioniert gut mit Luna sowie überprüfen Sie bitte auf dem Markt