Documentao de cdigo Java

CENTRO UNIVERSITRIO DE JOO PESSOA COORDENAO DE SISTEMAS DE INFORMAO

Jefferson Ferreira Barbosa jeffersonjpa@gmail.com

Joo Pessoa 2014

Obje%vos

Apresentar a forma de criar documentao de cdigo em java

Documentao

Quem escreveu no deve ser o nico a poder ler o cdigo

Aps desenvolvido um sistema precisa ser man

Qual a importncia da documentao ?

Qual a importncia da documentao ?

Qual a importncia da documentao ?

Documentao Assim, o soFware deve conter documentao Quando a documentao est separada do cdigo, torna-se diKcil mant-la.

Javadoc O J2SE possui uma ferramenta denominada javadoc que gera documentao html a par

Javadoc /** Comentrio de classe */ public class TesteDoc {

/** Comentrio de varivel */ public int i; /** Comentrio de mtodo */ public void m();

}

public class BubbleSort { public void bubbleSort(int[] numbers) { boolean numbersSwitched; do { numbersSwitched = false; for (int i = 0; i < numbers.length - 1; i++) { if (numbers[i + 1] < numbers[i]) { int tmp = numbers[i+1]; numbers[i+1] = numbers[i]; numbers[i] = tmp; numbersSwitched = true; } } } while (numbersSwitched); }

Javadoc Comentrios javadoc com HTML embu

Javadoc Tags gerais:

@deprecated adiciona um comentrio de que a classe, mtodo ou varivel no deve ser usada.

@deprecated

@since indica a verso do JDK quando o elemento em questo foi adicionado API Java

@since

Javadoc Tags gerais:

@see adiciona um link seo "Veja tambm" da documentao

@see @see

Javadoc Tags para comentrios de classes e interfaces: @author autor do elemento

@author

@version nmero da verso atual @version

Javadoc Tags para comentrios de mtodos: @param descreve os parmetros de um mtodo acompanhado por uma descrio @param

@return descreve o valor retornado @return

@throws indica as excees que um dado mtodo lana @throws

Javadoc /** * Esta classe representa uma calculadora * @author Rodrigo Fujioka * @author rodrigofujioka@gmail.com * @version 1.0 * @since 1.5 */ public class Calculadora {

/** * Mtodo responsvel por somar 2 nmeros * @param a primeiro nmero a ser somado * @param b segundo nmero a ser somado * @return soma dos nmeros passados como parmetros */ public double somar(double a, double b) {

return a + b; }

}

Gerando Documentao - Eclipse

Como Usar a Documentao Descrio da classe escolhida

- hierarquia - documentao detalhada, propriedades, mtodos, etc.

Lista de Pacotes Lista de classes e interfaces do pacote escolhido

Como Usar a Documentao

Como Usar a Documentao

Como Usar a Documentao

Como usar a Documentao - Construtor

Como usar a Documentao - Mtodo

Javadoc

On-line: hfp://java.sun.com/javase/6/docs/api/ Download: hfp://java.sun.com/javase/downloads/

Dvidas

DVIDAS ?