Uso de javadoc desde NetBeans
Sumario
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 "BC6. Documentación das aplicacións web e sistemas de control de versión"
- 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
- É necesaria a instalación de Netbeans:
Uso
/**
* 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
- 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:
- Xenera a api documentada con Javadoc
- Cambia a plantilla de estilo por outra da túa elección:
- Entrega un documento explicando qué fixches e anexando a documentación xenerada nun documento comprimido.