Documentación Técnica

**Entrega 2**

JavaDoc

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente.

Mi documentación técnica la realicé con el software JavaDoc, con base a mis archivos de clase de código fuente. Utilicé este software porque considero que es sencillo y genera una buena documentación .

Para poderla realizar primero abrí la terminal, me desplace hacia la carpeta donde tenia el código de mi proyecto y utilicé el comando javadoc *.java y empezó a generar la documentación.

Generó varios archivos HTML de los cuales el principal es el "index" en donde se muestra la lista de las clases, su descripción, entre otras cosas.

Al abrir el archivo index apareció la siguiente pantalla donde se puede apreciar mejor lo anteriormente mencionado:

Captura de mi Documentación Técnica