jueves, 2 de octubre de 2014

Comentario en Java | Como comentar o documentar un código en Java

En un programa Java hay tres tipos de comentarios.

Comentario de bloque. Empieza por /* y termina por */. El compilador ignora todo el texto contenido dentro del comentario.
/* 
* El programa HolaMundo se utiliza para aplicar los 
* métodos System.out.print() y System.out.println() 
*/
Comentario de documentación. Empieza por /** y termina por */. Java dispone de la herramienta javadoc para documentar automáticamente los programas. En un comentario de documentación normalmente se indica el autor y la versión del software.
/**
* Programa HolaMundo 
* @author Fundamentos de Informática 
* @version 1.0 
* @see Referencias 
*/
Comentario de línea. Empieza con //. El comentario comienza con estos caracteres y termina al final de la línea.
// El método System.out.println() salta la línea
El uso de comentarios hace más claro y legible un programa. En los comentarios se debe decir qué se hace, para qué y cuál es el fin de nuestro programa. Conviene utilizar comentarios siempre que merezca la pena hacer una aclaración sobre el programa.

0 comentarios:

Publicar un comentario