Java Language Documentazione sul campo


Esempio

Tutti i commenti Javadoc iniziano con un commento di blocco seguito da un asterisco ( /** ) e terminano quando fa il commento del blocco ( */ ). Facoltativamente, ogni riga può iniziare con spazi bianchi arbitrari e un singolo asterisco; questi vengono ignorati quando vengono generati i file di documentazione.

/**
 * Fields can be documented as well.
 * 
 * As with other javadocs, the documentation before the first period is used as a
 * summary, and is usually separated from the rest of the documentation by a blank 
 * line.
 * 
 * Documentation for fields can use inline tags, such as:
 * {@code code here}
 * {@literal text here}
 * {@link other.docs.Here}
 * 
 * Field documentation can also make use of the following tags:
 * 
 * @since 2.1.0
 * @see some.other.class.Documentation
 * @deprecated Describe why this field is outdated
 */
public static final String CONSTANT_STRING = "foo";