É MUITO MAIS FÁCIL DEIXAR A DOCUMENTAÇÃO DE ACORDO COM O CÓDIGO
/**
* Um objeto da classe <code>Atributo<code> define um atributo como
* par nome/valor onde o nome é uma <code>String<code> e o valor é um
* <code>Object<code> arbitrário.
*
* @version 1.1
* @author Goslin
* @since 1.0
*/
class Atributo {
/** O nome do atributo. */
private String nome;
/** O valor do atributo. */
private Object valor = null;
/**
* Cria o novo atributo com o nome dado e um valor inicial de <code>null<code>.
* @see Atributo#Atributo( String, Object )
*/
public Atributo( String nome ) {
this.nome = nome;
}
/**
* Cria um novo atributo com o nome e valor inicial dados.
* @see Atributo#Atributo( String )
*/
public Atributo( String nome, Object valor ) {
this.nome = nome;
this.valor = valor;
}
/**
* Retorna o nome desse atributo.
*/
public String getNome() {
return nome;
}
/**
* Retorna o valor desse atributo.
*/
public Object getValor() {
return valor;
}
/**
* Seta o valor desse atributo.
* @param novoValor O novo valor do atributo.
* @returns O valor original.
* @see #getValor()
*/
public Object setValor( Object novoValor ) {
Object valorVelho = valor;
valor = novoValor;
return valorVelho;
}
/**
* Retorna um string na forma <code>name=valor<code>.
*/
public String toString() {
return nome + "='" + valor + "'";
}
}