k19-k11-orientacao-a.. - Departamento de Sistemas e Computação

DOCUMENTAÇÃO 1222 *3 * Documentacao do atributo numero4 *5 */6 private int numero ;Código Java 13.5: Documentando um atributoDocumentando um construtorPara documentar um construtor, basta adicionar um comentário javadoc imediatamente acimada declaração do construtor que desejamos documentar.Os parâmetros de um construtor podem ser documentados através da tag @param. As exceptionsque podem ser lançadas por um construtor podem ser documentadas através da tag @throws.Essas duas tags podem se repetir no comentário javadoc caso o construtor tenha mais do que umparâmetro ou lance mais do que uma exception.1 /**2 *3 * Documentacao do construtor4 *5 * @param numero6 * documentação do parâmetro numero7 *8 * @throws IllegalArgumentException9 * documentação da situação que gera a exception IllegalArgumentException10 */11 public Conta ( int numero ) {12 if( numero < 0) {13 throw new IllegalArgumentException (" número negativo ");14 }15 this . numero = numero16 }Código Java 13.6: Documentando um construtorDocumentando um métodoPara documentar um método, basta adicionar um comentário javadoc imediatamente acima dadeclaração do método que desejamos documentar.Os parâmetros de um método podem ser documentados através da tag @param. As exceptionsque podem ser lançadas por um método podem ser documentadas através da tag @throws. O valorde retorno de um método pode ser documentado através da tag @return.1 /**2 *3 * Documentacao do método calculaTaxaDeEmprestimo4 *5 * @param valor6 * documentação do parâmetro valor7 *8 * @throws IllegalArgumentException9 * documentação da situação que gera a exception IllegalArgumentException10 *122 www.k19.com.br