Universidad Mariano Gálvez
Guatemala
Ingeniería en Sistemas Sede Boca
del Monte
Sección: “A” sábados
Programacion II
Investigacion
Luis Enrique Zambrano Pineda Carnet: 7690-20-465
Fecha: Guatemala 13/08/2022
Desde el IDE (IntelliJ, el que esté usando) como se genera la documentación
técnica de un proyecto Java.
La documentación técnica es muy importante en el desarrollo de software. Es
como una carta de navegación para tu equipo. Documentar tu proceso, sirve
como referencia explicando las razones del desarrollo, como opera y cómo
utilizarlo. Los equipos de software se refieren a este proceso de documentación
técnica cuando hablan de requerimientos, notas en la release o diferentes
aspectos en el desarrollo del producto. Utilizan documentos para detallar el
código, APIs, y realizar un seguimiento en el proceso de desarrollo de software.
Externamente, la documentación se plasma en manuales, guías de usuario para
administradores de sistemas, ayuda a los equipos y demás usos.
La documentación técnica sirve para ayudar a los nuevos miembros del equipo a
adaptar más rápido a los hábitos de trabajos de la compañía. Comparte
información del funcionamiento del producto y el porqué de cada requerimiento.
Hace que la curva de aprendizaje de los desarrolladores sea más suave. Y lo
hace señalando aquellos puntos de la aplicación en los que ha de centrarse el
desarrollador para saber más del contexto de aquella aplicación en la que están
trabajando.
Huddle es un centro de colaboración todo-en-uno para tu equipo. Básicamente,
tienes todas las herramientas que tu empresa necesita para estar sincronizadas,
incluidos el almacenamiento de archivos, la gestión de proyectos y las
herramientas de colaboración. Lo que es importante saber aquí es que esta
herramienta es para compañías grandes que necesitan un lugar seguro para
colaborar como empresa. El precio es de $ 20 por mes por usuario.
Read the Docs Es una plataforma gratuita para el alojamiento de documentación
de software con código fuente disponible gratuitamente. Facilita la redacción de
documentación técnica al automatizar la creación, el control de versiones y el
alojamiento para tí.
Javadoc es un generador de documentación creado por Sun Microsystems para
el lenguaje Java para generar documentación de API en formato HTML desde el
código fuente de Java.
Markdown es un lenguaje de marcado suave con sintaxis de formato de texto
plano. Está diseñado para que puedas conertir a HTML y muchos otros formatos
utilizando una herramienta con el mismo nombre. Markdown se usa a menudo
para formatear archivos “readme”, para escribir mensajes en foros de discusión
online y para crear texto usando un editor de texto simple.
2. Definir la nomenclatura para la documentación de:
1. Una Clase
2. Atributo
Usualmente los atributos por ser privados Javadoc no los muestra, pero se puede
forzar para que sean visibles y solo se debería colocar un pequeño comentario sin
ninguna palabra reservada.
3. Método (incluyendo sus parámetros y valor de retorno)
3. Tomando en cuenta los dos pasos anteriores, debe generar la documentación
técnica de lo que entregó en alguna Tarea anterior.
