¿Cómo puedo hacer referencia al valor de un campo estático final en la clase?

Usando JavaDoc, ¿cómo puedo hacer referencia al valor de un campo estático final en la clase?

Quiero que ???en este ejemplo se reemplace por el valor del campo 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 Simón
fuente

Respuestas:

194

¿Te refieres {@value #STATIC_FIELD}?

Marqués de Lorne
fuente

¿Se puede hacer referencia a esto también en otras clases? cuando traté de hacer eso, no funcionó para mí.

Rajith Gun Hewage

@RajithGunHewage, puede hacer referencia a él desde otra clase como{@value com.package.other.Clazz#STATIC_FIELD}

Sean

Por si acaso, para las constantes no primitivas será {@link #STATIC_NON_PRIMITIVE_FIELD}

Yuriy

@Sean, de hecho, debería ser usando {@link com.package.other.Clazz # STATIC_FIELD}

Cristian Ebbens

@Yuriy Eso no es correcto. {@link ...}proporciona un enlace al Javadoc del campo nombrado, que a su vez no proporciona el valor. {@value ...}proporciona el valor real, que es lo que se solicitó. "No primitivo" no tiene exactamente nada que ver con eso. Vea el ejemplo de {@value ...}en la documentación de la herramienta Javadoc, por ejemplo, que usa java.lang.String.

Marqués de Lorne