Kurze Frage: Ist es möglich, Javadoc für lokale Variablen zu erstellen? (Ich möchte nur eine Erklärung für meine lokale Variable, wenn ich in Eclipse darüber schwebe) Danke für jeden Hinweis :-)Javadoc für lokale Variablen?
Die lokale Variable sollte ein paar Zeilen über ihrer Verwendung deklariert werden. Verwenden Sie einfach regelmäßig Kommentare, wenn Sie müssen. Aber was noch wichtiger ist: Halten Sie Methoden kurz, wählen Sie aussagekräftige Namen für sie und deklarieren Sie sie nur, wenn Sie sie brauchen. In den meisten Fällen ist es nicht notwendig, lokale Variablen zu kommentieren.
Bevorzugen
int numberOfBooks = books.size();
über
// the number of books
int n;
... // 50 lines of code
n = books.size();
Ich stimme zu, es ist unnötig * die meiste Zeit *, aber es gibt einfach Dinge, die komplexer zu erklären sind als die Anzahl der Bücher und solche Sachen, vor allem bei komplexeren Berechnungen usw. –
Nein, es ist nicht unterstützt, da JavaDoc Generation es ignoriert.
Ja, es ist möglich. Machen Sie einfach einen regulären Javadoc-Kommentar über der Variablen.
public class ExampleClass {
/** A really cool variable */
int localVariable;
...
Jetzt können Sie weiter unten über die Variable im Code schweben und der Kommentar angezeigt wird.
Es kann Annotations verwendet werden.
Erstellen Sie eine einfache Annotationstyp wie die folgenden:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
String value();
}
und auf Ihrem lokalen Variablen verwenden:
@LocalVariableDocumentation("A very important object!")
Object anImportantObject;
Eclipse die Anmerkung im Tooltip angezeigt.
Große Lösung, warum diese Antwort nicht akzeptiert wird? – Ced
Die einzige Möglichkeit, die es möglich ist, ist mit globalen Variablen. Lokale Variablen können nicht mit JavaDocs kommentiert werden.
So stellen Sie einen Link zu Ihrer lokalen Variablen
String someLocalVariable;
/**
* This a local variable: {@link #someLocalVariable}
*/
Dies funktioniert nicht auf Eclipse Mars, oder? – Ced
Sie Variable Beschreibung in Methode des JavaDoc Kommentar enthalten kann –
Irgendwann, wenn Sie eine andere Person Code debuggen müssen und lokale Variablen sind chaotisch, würde es helfen. – Ced