Taller de Programación Orientada a Objetos – Semana 4 – Reporte 4
Que tal compañeros!!
En la siguiente entrada les mostraré como aplique la herramienta JAVADOC a mi código en particular. La verdad fue muy fácil y sencillo y lo mejor es que no hay que instalar nada (tomando en cuenta que han instalado el JDK, y que están codificando en el lenguaje JAVA)
Para referencias de cómo instalar JDK en sus equipos den clic AQUÍ
Para empezar hay que identificar cada clase, y a su vez los métodos que dicha clase, y a su vez los parámetros que recibe el método y el valor que regresa.
Después hay que tener aunque sea una vaga idea de para qué sirve cada parte que hemos identificado, para así lograr generar un comentario sólido y explicar claramente su funcionalidad.
Posteriormente procederemos a generar nuestra documentación con el comando: javadoc, en mi caso con la siguiente sintáxis:
Posteriormente procederemos a generar nuestra documentación con el comando: javadoc, en mi caso con la siguiente sintáxis:
En las imágenes pueden ver ejemplos de los comentarios que introduje en mi código, así como parte de las clases con sus métodos que intenté explicar.
Después de una serie de comentarios parecidos en otras clases y métodos de mi código logré un resultado como este:
Son varias capturas de pantalla donde se muestra la documentación generada por Javadoc.
Y una parte del HTML generado, también vía captura de pantalla.
Espero les sea útil esta información
Saludos!!!
Pues, habría que agregar los comentarios tipo @param en los constructores y por lo general empezar a pensar en más métodos, sus parámetros, sus salidas y todo eso. Y sería bueno tener un webhosting para poner el HTML generado. Por ahora todo aceptable. 5.
ResponderEliminar