Como posso fazer referência ao valor de um campo estático final na classe?

Usando JavaDoc, como posso fazer referência ao valor de um campo estático final na classe?

Quero que ???neste exemplo seja substituído pelo valor do 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 Simon
fonte

Respostas:

194

Você quer dizer {@value #STATIC_FIELD}?

Marquês de Lorne
fonte

isso pode ser referenciado em outras classes também? quando tentei fazer isso, não funcionou para mim.

Rajith Gun Hewage

@RajithGunHewage, você pode fazer referência a ele em outra classe, como{@value com.package.other.Clazz#STATIC_FIELD}

Sean

Por precaução, para constantes não primitivas será {@link #STATIC_NON_PRIMITIVE_FIELD}

Yuriy

@Sean, na verdade, deveria estar usando {@link com.package.other.Clazz # STATIC_FIELD}

Cristian Ebbens

@Yuriy Isso não está correto. {@link ...}fornece um link para o Javadoc do campo nomeado, que por sua vez não fornece o valor. {@value ...}fornece o valor real, que é o que foi solicitado. 'Não primitivo' não tem exatamente nada a ver com isso. Veja o exemplo de {@value ...}na documentação da ferramenta Javadoc, por exemplo, que usa java.lang.String.

Marquês de Lorne