~Semana 4. Documentación y herramientas

Semana 4

Materia: Programación Orientada a Objetos

Martes M1-M3

Hola compañeros, en esta entrada les hablaré de la importancia de la documentación en un programa que realizamos.

Bueno primero que nada el propósito de la documentación es añadir información explicando todo lo que estamos haciendo, de modo en que todos puedan entender nuestro código y que hace o para que sirve cada método, cada atributo que ponemos.

Esto también puede servir para encontrar errores en algun código más facilmente sabiendo que es lo que se quiere hacer y sabiendo esto es más facil encontrar un error. Por esto es necesario que el programa se entienda, para que después pueda modificarse o arreglar errores.

Los comentarios para hacer la documentación se deben poner en métodos, atributos dentro de una clase y también en las clases.

Java tiene una herramienta javadoc el cual genera un conjunto de archivos que crean está documentacion en páginas web. Esta herramienta toma los comentarios que tu le pones al código y te permite decidir si quieres que se muestren todos los métodos o solo los públicos y los privados no o que se muestren todos.

En la documentación también se usan ciertas etiquetas que también sirven para hacer más clara la documentación, por ejemplo la etiqueta @param refiere a un parametro de un método o constructor y seguido de esto debe ir la explicación de dicho parámetro.

Aquí dejo unas tablas de algunas etiquetas.

Para las clases e interfaces

Para métodos o constructores

Bueno, esto sería todo espero que les haya ayudado en algo. Saludos a todos, cualquier duda o comentario son bien recibidos.