Ich weiß, man kann '<alt> <shift> J' verwenden, um Tags für ein einzelnes Codeelement (Klassenmethode zum Beispiel) zu erstellen.Kann man automatisch Javadoc-Tags für ein ganzes Eclipse-Projekt erstellen?
Aber ist es eine Möglichkeit, diese Tags für jede Klasse im gesamten Projekt automatisch zu erstellen? Oder sogar nur auf Paket- oder Klassenebene?
Haben Sie bei JAutodoc geschaut?
Nicht, dass ich weiß.
Wofür wäre das überhaupt gut? Automatisch generierte Javadoc-Kommentare sind schlimmer als nutzlos; Ich möchte lieber nicht, dass sie meinen Code überladen, und Javadoc wird so viele Informationen zur Verfügung stellen, auch wenn kein Kommentar vorhanden ist.
Ich verwende Checkstyle, um mich dazu zu zwingen, jede Methode in meinem Code zu kommentieren. – akarnokd
Die Idee wäre, die Tags zu erstellen, die ich dann mit den erforderlichen Kommentaren füllen kann. Ich stimme zu, dass leere Javadoc-Kommentare schlimmer als nutzlos sind. –
Checkstyle weiß nicht, ob ein Kommentar tatsächlich nützliche Informationen enthält. Das letzte, was Sie wollen, sind automatisch generierte nutzlose Kommentare, die Checkstyle befrieden. Außerdem würde ich sagen, dass das Schreiben eines Kommentars bei vielen Methoden Zeitverschwendung ist, da es keine Informationen enthält, die die Methoden- und Parameternamen nicht bereits enthalten. –
automatisch generierte JavaDoc ein Schmerz ist, weil andere Leute nie jetzt, was die Methode tun sollten, und selbst wird auch wissen, dass es nicht, wenn Sie ein Jahr später in der Klasse zu suchen.
Bitte kommentieren Sie selbst Ihre Methoden oder tun das Verfahren nicht kommentieren.
Meine Firma nutzt die Arbeitgeber Check zu zwingen javadoc hinzuzufügen. Einige Arbeitgeber hassen es, ihre Methoden zu kommentieren und einfach sinnlose Kommentare zu schreiben. Es wäre besser, dass sie keinen Kommentar abgeben, als einen nutzlosen.
Mit Check Sie alle undokumentierten Methoden finden können, so dass sie in einem gut Format zu dokumentieren.
Was werden Ihnen helfen, eine Init-Methode wie
zu dokumentieren „init hat vor jeder anderen Methode aufgerufen und initialisiert die Klasse ActionDummy“
es besser ist, was zu sagen genau ist getan
Initialisiert den Standardstatus des Aktionsproviders. Einige Statusvariablen können vom Listener überschrieben werden, wenn ....
Aber es scheint, dass die JAutodoc-Option "Add ToDo für automatisch generiertes Javadoc" Ihr (sehr gültiges) Anliegen ansprechen würde, nicht wahr? Eine Zeile '// TODO: Automatisch generierter Kommentar 'müsste nach dem Bearbeiten des Javadoc für jede generierte Dokumentation entfernt werden. – VonC
Es ist kein Problem in meiner Firma, da ich der einzige Entwickler bei den meisten Projekten bin und die anderen in den Rollen Manager, Architekt, Associate, Tester, Document-Writer etc (ja, 1: 5) sind. – akarnokd
Warum sollten Sie ein automatisch generiertes Javadoc verwenden, wenn Sie es in jedem Fall überprüfen müssen, indem Sie das TODO entfernen –
Das sieht genau nach was ich suche. Jetzt herunterladen. –