Bearbeiten von Javadoc $ {tags} Variable von Eclipse
Version: Luna Service Release 2 (4.4.2)
Ich verwende in der Regel die Methode "/ **", um Javadoc in meine Methoden einzufügen. Eclipse fügt @param für alle Args, @throws für alle Throwables und% @return ein. Der @return hat jedoch keinen angehängten Typ. Es sieht so aus:
Die erste Frage lautet: Gibt es irgendwo in Eclipse einen Schalter, damit er beim Hinzufügen von Javadoc automatisch den Rückgabetyp der Methode einfügt?
Ich konnte keinen finden, also habe ich nachgeschaut: Voreinstellungen- & gt; Java- & gt; Code-Stil- & gt; Code-Vorlagen- & gt; Methoden
Auf dieser Vorlage sehe ich eine Variable ${tags} . Diese Variable erzeugt das oben gezeigte Javadoc.
Die zweite Frage lautet: Gibt es eine Möglichkeit, ${tags} so zu bearbeiten, dass sie die an @return angehängte Variable ${return_type} enthält, die von ${tags} erzeugt wird?
Ich möchte /**<enter> eingeben und Eclipse automatisch das folgende Javadoc erstellen lassen:
3 Antworten
Gemäß Ihrer Frage gibt es (noch) keine Konfiguration in Eclipse, die es Ihnen erlaubt, dies zu ändern. Das liegt daran, dass sich die Kommentare in Javadoc mit dem Tool beschweren müssen, das automatisch die Klassen javadoc HTML erzeugt. Wenn man das ändern könnte, sollte das Tool javadoc auch eine Konfiguration haben, um diese Änderungen zu verstehen.
Sie müssen sich darüber keine Gedanken machen, da dieses Tag @return für eine Javadoc-Generierung gedacht ist. Sobald Sie Ihr Projekt javadoc generieren, sehen Sie, dass jede Methode den Rückgabetyp (im generierten html) hat. Dieses Tag ist für eine spezifische Beschreibung des Ergebnisses der Methode.
Nehmen Sie diese Methode Beispiel:
%Vor% Wenn Sie in Eclipse den Mauszeiger über diese Methode anhalten, wird dies angezeigt:
Achten Sie auf die erste Zeile dieser Dokumentation auf dem Bild. Es heißt: String Foo.getSomeAttribute()
Wenn Sie das Javadoc über das Tool javadoc oder ein anderes Tool wie Maven generieren, generiert es alle HTML-Dateien mit allen Javadocs Ihrer Klassen und die Methodensammlung wird wie diese aussehen ( String-Klasse )
Sie können in der Spalte "Modifier and type" den Rückgabetyp der Methoden sehen. Wenn Sie sich den Quelltext einer dieser Methoden ansehen, wie die erste im Bild charAt(int index) , sehen Sie, dass es im @return -Tag keinen Typ gibt.
Ich hoffe, es hilft Ihnen, dieses Tag zu verstehen.
Die Variable ${tags} scheint in Eclipse nicht editierbar zu sein. Nachdem Sie einen Teil des Codes durchgearbeitet haben, finden Sie hier eine Link zu der Klasse, die für die Auflösung der Variablen zuständig ist. Speziell die Methode insertTag :
Beachten Sie, dass der Rückgabetyp nicht angefügt werden kann. Nur @return wird in die Vorlage eingefügt.
Es gibt zumindest einen sehr hacky Weg, es zu tun. Sie können die Vorlage weiterhin aktualisieren, indem Sie zu Fenster - & gt; Einstellungen - & gt; Java - & gt; Codestil - & gt; Codevorlagen - & gt; Kommentare und wählen Sie Bearbeiten , um die Kommentarvorlage zu bearbeiten. Sie können die Vorlage dann ändern in:
%Vor%Siehe Ссылка für verfügbare Variablen.
Aber das führt dazu, dass zwei Kommentare @return hinzugefügt werden. Wie in der anderen Antwort erwähnt, ist das Hinzufügen eines Rückgabetyps nicht erforderlich, da der Javadoc-Generator den Rückgabetyp automatisch ermitteln kann. Wenn Sie die Kommentare in einem anderen Tool analysieren, kann die obige Problemumgehung das Problem lösen.