Kann man automatisch javadoc-Tags für ein gesamtes Eclipse-Projekt erstellen?

Question

Ich weiß, man kann verwenden ' J' Tags für ein einziges Codeelement (Klassenmethode zum Beispiel) zu erstellen.

Aber gibt es eine Möglichkeit, automatisch diese Tags für jede Klasse im gesamten Projekt zu erstellen? Oder auch nur auf Paket oder Klassenstufe?

Answer 1

Haben Sie unter JAutodoc ?

Answer 2

Nicht, dass ich wüsste.

Was würde das für jeden Fall gut sein? Automatisch generiert Javadoc Kommentare sind schlimmer als nutzlos; Ich möchte lieber nicht haben sie meinen Code unübersichtlich und Javadoc werden so viele Informationen auch ohne Kommentar vorhanden liefern.

Answer 3

Automatische generierte JavaDoc ein Schmerz ist, weil andere Leute nie jetzt, was die Methode tun sollten, und selbst wird auch wissen, dass es nicht, wenn man sich die Klasse ein Jahr später aussehen.

Bitte äußern Sie Ihre Methoden selbst oder haben das Verfahren nicht kommentieren.

Meine Firma nutzt die Arbeitgeber Check zu zwingen javadoc hinzuzufügen. Einige Arbeitgeber hassen es, ihre Methoden zu kommentieren und gibt nur sinnlose Kommentare. Es wäre besser, dass sie kein Kommentar ist als ein nutzlos.

Mit Check können Sie alle nicht dokumentierten Methoden finden, so dass sie in ein gut Format zu dokumentieren.

Was werden Ihnen helfen, eine Init-Methode wie

zu dokumentieren

  

"init muss vor jedem aufgerufen werden   andere Verfahren und initialisiert die Klasse   ActionDummy "

Es ist besser zu sagen, was genau geschehen ist

  

Inizializes den Standardstatus der   Action-Anbieter. Einige Zustandsgrößen sein   vom Hörer außer Kraft gesetzt, wenn ....