Uso de javadoc desde NetBeans

De MediaWiki
Ir a la navegación Ir a la búsqueda

Consideracións pedagóxicas

Este material pode ser utilizado:

  • No módulo Despregue de Aplicacións Web do Ciclo de Desenvolvemento de Aplicacións web
    • No "BC6. Documentación das aplicacións web e sistemas de control de versión"
      • Xeradores de doumentación integrados nas plataformas de desenvolvemento
      • Formatos estándar para a documentación. Uso de linguaxes de marcas na documentación de aplicacións web.
  • No módulo Contornos de Desenvolvemento do Ciclo de Desenvolvemento de Aplicacións web

Consideracións previas

  • É convinte un coñecemento básico de programación, do uso dos IDE (en particular Netbeans) e e a linguaxe Java

Instalación

Uso

      //EXEMPLO DE PROGRAMA JAVA PARA PROBAR JAVADOC
      /**
      * Unha clase para empezar a programar en Java
      * o clásico exemplo de OlaMundo
      * @version 2.1.0, 15/10/20
      * @author Xose Programador Java 
      */
public class holamundo {
   /** 
   * Amosa a mensaxe de Ola Mundo
   */
     public static void main(String[] args) {
          // TODO Auto-generated method stub
          System.out.println("Ola mundo!");
     }
}

Posible tarefa

  1. Documenta o código, como se fai neste exemplo dunha función que recibe un número e devolve un texto con ese número:
    1. https://www.youtube.com/watch?v=KChdcRscFt0
  1. Xenera a api documentada con Javadoc
  2. Cambia a plantilla de estilo por outra da túa elección:
    1. http://java-white-box.blogspot.com/2012/08/javadoc-como-personalizar-el-html.html
  3. Entrega un documento explicando qué fixches e anexando a documentación xenerada nun documento comprimido.

Referencias

Créditos