Jak mogę odwołać się do wartości końcowego pola statycznego w klasie?

99

Jak za pomocą JavaDoc mogę odwołać się do wartości końcowego pola statycznego w klasie?

Chcę, aby ???w tym przykładzie zastąpiono wartością pola 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";

}
Szymon
źródło

Odpowiedzi:

196

Czy masz na myśli {@value #STATIC_FIELD}?

Markiz Lorne
źródło
3
czy można się do tego odwoływać również w innych klasach? kiedy próbowałem to zrobić, nie wyszło mi to.
Rajith Gun Hewage
22
@RajithGunHewage, możesz odwołać się do niego z innej klasy, takiej jak{@value com.package.other.Clazz#STATIC_FIELD}
Sean
3
Na wszelki wypadek, dla stałych nieprymitywnych będzie to {@link #STATIC_NON_PRIMITIVE_FIELD}
Yuriy
1
@Sean, właściwie powinno to być za pomocą {@link com.package.other.Clazz # STATIC_FIELD}
Cristian Ebbens
1
@Yuriy To nie jest poprawne. {@link ...}zawiera odsyłacz do pliku Javadoc nazwanego pola, które z kolei nie dostarcza wartości. {@value ...}podaje rzeczywistą wartość, o którą prosiliśmy. „Nieprymitywny” nie ma z tym nic wspólnego. Zobacz przykład {@value ...}w dokumentacji narzędzia Javadoc, na przykład, które używa java.lang.String.
Markiz Lorne