Warum fügt/** [newline] nicht immer die Javadoc-Vorlage einschließlich @param und @return in Eclipse ein?

Ich dokumentiere Code in Eclipse und benutze die/** gefolgt von Geben Sie eine Menge ein, um die Javadoc Vorlage einzufügen. Aus irgendeinem Grund funktioniert das nicht immer, aber es wird die Vorlage zum Schreiben von Kommentaren erstellt, aber es wird nicht automatisch den Text @param und @return einfügen. Wenn ich die exakt gleiche Methode in eine andere Klasse kopiere, wird die vollständige Vorlage eingefügt.Warum fügt/** [newline] nicht immer die Javadoc-Vorlage einschließlich @param und @return in Eclipse ein?

Es wäre eine große Hilfe, wenn mir jemand sagen könnte, warum das in manchen Situationen nicht geht.

Quelle

2010-06-07 Sebastiaan van den Broek

Soweit ich weiß, geschieht dies normalerweise, wenn Eclipse nicht sicher ist, welche Methode Sie dokumentieren möchten. Ein zuverlässigerer Weg wäre, die Methode/Klasse usw. auszuwählen, für die Sie das JavaDoc erstellen möchten, und drücken Sie ALT + UMSCHALT + J oder klicken Sie mit der rechten Maustaste auf die Methode in der Klassengliederung und klicken Sie auf Quelle -> Elementkommentar generieren .

Quelle

2010-06-07 10:30:43 Daff

Hitting diese Verknüpfung wird mich auf die Schnittstelle, die diese Klasse implementiert (dh es fügt (nicht-Javadoc) und dann eine Zeile mit @See package.class # -Methode (params), ich denke, es ist nicht wie Javadoc sein hinzugefügt zu einer Klasse, die eine Schnittstelle implementiert Also, wenn ich aus irgendeinem Grund die Implementierung einer Schnittstelle dokumentieren möchte, werde ich es manuell tun müssen.Es ist mir klar, dass dies nicht der beste Weg, um die Dokumentation aber Ich habe mich nur gewundert, warum es nicht funktioniert hat. Danke! –

Nun der ganze Punkt von Methoden, die von einer Schnittstelle beschrieben werden, ist, dass die Schnittstelle bereits alle erforderlichen Dokumentation enthält (und die Implementierungsmethoden sollten sich nicht anders verhalten als das Schnittstelle spezifiziert). Ich würde zusätzliche Informationen in die Javadoc-Klasse Header setzen. – Daff

Ich habe gerade ein anderes Beispiel in einer Klasse gefunden, die nichts erweitert oder implementiert. Keine Ahnung, warum es nicht mit/** funktioniert, aber alt-shift-j fügt die Javadoc-Vorlage korrekt ein. –

Es funktioniert immer für mich, es sei denn, es gibt einen Kommentar über die Methode, für die ich versuche, die Dokumentation hinzuzufügen. Hier ist ein Beispiel von Code und einen nicht dokumentierten Verfahren, bei dem es nicht funktionieren würde:

public class Test { 
    // Declare some fields. Bla bla bla. 

    // ~ Constructors 

    public Test() { // <-- If I insert /** above this line it fails to work 
    } 
}

Meine fix in die Regel ist, um vorübergehend eine Variable zu deklarieren, dass meine Methode aus den Kommentaren trennt so das Eclipse erkennt, was ich tue. ..

public class Test { 
    // Declare some fields. Bla bla bla. 

    // ~ Constructors 
    int i; 
    public Test() { // <-- If I insert /** above this line it works. Then discard the temp var. 
    } 
}

Quelle

2011-04-20 09:32:17 Jel

Dies begann mit mir gelegentlich mit dem letzten Build, Mars. Neustart von Eclipse behebt es. Es scheint, dass ich Eclipse jeden Tag neu starten muss, um zufällige Probleme wie diese zu vermeiden.

Quelle

2015-08-07 16:14:52

Warum fügt/** [newline] nicht immer die Javadoc-Vorlage einschließlich @param und @return in Eclipse ein?

Antwort

Verwandte Themen