Gibt es eine Möglichkeit, automatisch alle Javadoc-Kommentare in Eclipse zu generieren?

Question

Ich weiß, dass Sie shift + alt + j drücken können, um eine passende Kommentarvorlage für den aktuellen Codeblock einzufügen, aber gibt es irgendeine Möglichkeit, eclipse einfach verrückt zu machen und ein ganzes Projekt wie dieses zu machen?

Answer 1

Für ein ganzes Projekt, nicht sein kann, aber man kann zumindest:

• geht an die Paket-Explorer-Ansicht
• die Klasse, die Sie auf generieren Kommentar mögen erweitern (jede Methode geöffnet)
• wählen Sie alle geöffneten Elemente in der Klasse von diesem Baum Package Explorer
• alt + Verschiebung + J und voilà: Kommentare zu der Klasse erzeugt, und jede Methode

Der einzige Grund, warum es nicht praktisch für das Gesamtprojekt ist:

• Sie jede Klasse, die Sie generieren möchten öffnen müssen Kommentare zu
• Sobald ein erster Satz von Methoden kommentiert wurde, müssen Sie den Prozess noch einmal wiederholen, wenn Sie neue Methoden geschrieben haben.

---

Davon abgesehen, ist ein weiterer Ansatz, in dem Artikel "The Problem of Incomplete Javadocs" von März beschrieben 30. 2010 für eine extended Javadoc view befürworten.

Die erweiterte Javadoc-Ansicht ist im Wesentlichen ein Aggregator verschiedener Informationsquellen für ein einzelnes Codeelement wie eine Klasse, Methode, Feld oder Parameter. Es ist als Ersatz für das bestehende Eclipse Javadoc gedacht.

Der interessante Teil kommt mit den anderen Register in der Ansicht: Subclassing Richtlinien und Subclassing Patterns.
Diese Register enthalten Informationen darüber, wie Entwickler das ausgewählte Codeelement normalerweise erweitert haben.

• Subclassing tab:

Subklassifizieren Richtlinien Verallgemeinerungen von häufig gemachten Beobachtungen in Beispielcode sind wie "Subklassen von Wizard immer seine Methode überschreiben addPages()" oder "Reimplementors von Dialog.createContents() kann seine Super nennen Implementierung".

• Subclassing Patterns Tab

Subclassing Muster Gruppe versuchen Erweiterungen von einer Basisklasse in typische Erweiterung Muster beobachtet, das heißt Cluster sie Subklassen durch Ähnlichkeit, um Muster in Daten zu finden.

Answer 2

Es gibt auch dieses Plugin, das ich noch versuchen müssen, aber sieht vielversprechend aus: JAutoDoc

Answer 3

ich auch für ein Auto-javadoc-Tool für Eclipse und fand einen JAutodoc genannt suchte.

Dieses Tool generiert Kommentare ziemlich gut und erfordert nur geringfügige Änderungen an einigen Stellen manuell (wenn Sie möchten). Meiner Meinung nach kann dieses Tool ungefähr 75% der Zeit sparen, die beim Schreiben von Kommentaren aufgewendet wird.

Sie können here für detaillierte Anweisungen zum Herunterladen und die Integration mit Eclipse besuchen.