Proxecto de documentación
Sumario
Tarefa
La práctica consistirá en adquirir un mayor aprendizaje de las herramientas de documentación interna de proyectos, ejemplarizando su uso con Javadoc y phpDocumentor.
Enunciado
Para ello, habrá que elaborar un documento de texto y una presentación o vídeo que será expuesto en el aula al resto de compañeros.
El escenario de la prueba puede ser la gestión de una aplicación real desarrollado por el alumno, o una facilitada por el docente.
El documento de texto contendrá:
- Portada (con nombre y apellidos del alumno)
- Estado del arte en el uso de herramientas de documentación interna de proyectos
- Descripción de ejemplos de uso
- Resultados obtenidos y conclusiones de los alumnos
NOTAS. Opcionalmente, se podrá hacer por parejas, notificando previamente al profesor, y aumentando el alcance de la práctica con sugerencias hechas por la pareja (por ejemplo, realizando ejemplos de pruebas unitarias con junit)
Entregables
- Todo junto en un archivo comprimido, o hasta en tres ficheros.
- Obligatoriamente se debe entregar memoria en documento de texto, y presentación y/o vídeo demostrativo
Referencias
Javadoc
- How to Write Doc Comments for the Javadoc Tool
- javadoc: documentación de programas
- Etiquetas principales que se usan en JAVADOC y ejemplos
