Javadoc für lokale Variablen?

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 mich in Eclipse darüber bewege.) Danke für jeden Hinweis :-)

questionAnswers(6)

Nein, es wird nicht unterstützt, da die JavaDoc-Generierung dies ignoriert.

Es kann mit getan werdenAnnotations.

Erstellen Sie einen einfachen Anmerkungstyp wie den folgenden:

<code>@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.LOCAL_VARIABLE)
@interface LocalVariableDocumentation {
    String value();
}
</code>

Und verwenden Sie es für Ihre lokale Variable:

<code>@LocalVariableDocumentation("A very important object!")
Object anImportantObject;
</code>

Eclipse zeigt die Anmerkung im Tooltip an.

Die lokale Variable sollte einige Zeilen über ihrer Verwendung deklariert werden. Verwenden Sie einfach regelmäßige Kommentare, wenn Sie müssen. Vor allem aber sollten Sie die Methoden kurz halten, aussagekräftige Namen für sie auswählen und sie nur dann deklarieren, wenn Sie sie benötigen. In den meisten Fällen ist es völlig unnötig, lokale Variablen zu kommentieren.

Bevorzugen

<code>int numberOfBooks = books.size();
</code>

Über

<code>// the number of books
int n;
... // 50 lines of code
n = books.size();
</code>

Ja es ist möglich. Machen Sie einfach einen regulären Javadoc-Kommentar über der Variablen.

<code>public class ExampleClass {
    /** A really cool variable */
    int localVariable;

    ...
</code>

Jetzt können Sie weiter unten über die Variable im Code fahren und der Kommentar wird angezeigt.

Stellen Sie einfach einen Link zu Ihrer lokalen Variablen her

<code>String someLocalVariable;
/**
 * This a local variable: {@link #someLocalVariable}
 */
</code>

Das ist nur mit globalen Variablen möglich. Lokale Variablen können nicht mit JavaDocs kommentiert werden.

yourAnswerToTheQuestion