Wie kann ich auf den Wert eines endgültigen statischen Felds in der Klasse verweisen?

Wie kann ich mit JavaDoc auf den Wert eines endgültigen statischen Felds in der Klasse verweisen?

Ich möchte das ???in diesem Beispiel durch den Wert des Feldes ersetzen STATIC_FIELD.

/**
 * This is a simple class with only one static field with the value ???.
 */
public class Simple {

    /**
     * We can reference the value with {@value} here, 
     * but how do we reference it in the class JavaDoc?
     */
    public static final String STATIC_FIELD = "simple static field";

}

java documentation javadoc Simon
quelle

Antworten:

194

Meinst du {@value #STATIC_FIELD}?

Marquis von Lorne
quelle

Kann dies auch in anderen Klassen erwähnt werden? Als ich das versuchte, hat es für mich nicht geklappt.

Rajith Gun Hewage

@ RajithGunHewage, können Sie es aus einer anderen Klasse wie{@value com.package.other.Clazz#STATIC_FIELD}

Sean

Nur für den Fall, für nicht-primitive Konstanten ist es {@link #STATIC_NON_PRIMITIVE_FIELD}

Yuriy

@ Sean, in der Tat sollte es mit {@link com.package.other.Clazz # STATIC_FIELD}

Cristian Ebbens

@Yuriy Das stimmt nicht. {@link ...}stellt einen Link zum Javadoc des benannten Felds bereit, der wiederum den Wert nicht liefert. {@value ...}liefert den tatsächlichen Wert, nach dem gefragt wurde. 'Nicht-primitiv' hat genau nichts damit zu tun. Siehe zum Beispiel das Beispiel {@value ...}in der Javadoc-Tooldokumentation, das verwendet java.lang.String.

Marquis von Lorne