Javadoc

3 respostas
E

gostaria de saber o que é javadoc pra que serve…??
alguém tem algum exemplo me mostrandu como funciona…?

3 Respostas

C

Javadoc é um sistema de documentação criado pela Sun Microsystems para documentar a API dos programas em Java, a partir do código-fonte. O resultado é expresso em HTML. É constituído, basicamente, por algumas marcações muitos simples inseridas nos comentários do programa.

Fonte: http://pt.wikipedia.org/wiki/Javadoc

J

Veja o exemplo de uma documentação no estilo javadoc, está é a da propria API do Java:

http://java.sun.com/j2se/1.5.0/docs/api/index.html

exemplo de como fazer:

/**Está é minha classe calculadora
* @author Jair Elton
* @version 1.0
*/
public class Calculadora{
   /**Soma dois numeros
    */
   public double somar(double a, double b){
        return a+b;
   }

   /**Multiplica dois numeros
   */
   public double multiplicar(double a, double b){
        return a*b;
   }

   //continua
}

Veja que os comentarios javadoc tem 2 asteriscos ao inves de 1:
/**comentario javadoc*/
/*comentario não javadoc*/

No console você digita:

javadoc Calculadora

E

muito obrigado pela dica…!

Criado 6 de agosto de 2006
Ultima resposta 7 de ago. de 2006
Respostas 3
Participantes 3