Los comentarios tienen gran importancia para describir lo que hace un programa.
Por mucho que implementemos un buen código y lo mejoremos con revisiones, la tarea se hará más difícil si el código fuente no está bien documentado.
Los comentarios en Java pueden ser de tres tipos diferentes:
- Comentarios de una sola línea. Se utiliza la barra doble // y posteriormente escribimos el comentario. Lo podemos hacer sobre la línea de código que queremos comentar o justo al lado. Ejemplo de comentario de una línea.
- Comentarios de múltiples líneas. Es cuando comentamos varias líneas. Se usa para comantarios más largos. Se comienza con barra inclinada y asterisco (/*) y se termina con (*/). Veamos un ejemplo de varias líneas comentadas.
- Comentarios Javadoc. Aquí los delimitadores que vamos a usar son /** y */. Al igual que el resto de comentarios, el texto que se haya generado entre estos delimitadores no lo tendrá en cuenta el compilador.
Veamos un ejemplo donde usamos comentarios Javadoc:
En este ejemplo de Javadoc hemos usado dos etiquetas o anotaciones. Veamos que significan.
- @author. Nombre del desarrollador.
- @version. En este caso es la versión de la clase.
Hay muchas más. Con ayuda del entorno de desarrollo que estés usando puedes ver todas las disponibles.
No olvidemos una cosa. Los comentarios en Java son una ayuda para entender el código. Es muy importante hacer un código legible. Tienen que preocuparte dos cosas.
- Que en el futuro alguien pueda entender el código gracias a unos buenos comentarios.
- Que en el futuro tú puedas entender el código gracias a unos buenos comentarios.
Por muy raro que te parezca, te puedes perder. Cuando retomas un proyecto después de un tiempo puede ser difícil recordar lo que hacía.
Recuerda que todos los lenguajes de programación tienen comentarios. Puede habar similitudes, pero cada uno los implementa a su modo particular.
Si te he sido de ayuda, déjame un «comentario», jeje.
Deja una respuesta