En la breve publicación de hoy vamos a tratar la importancia de añadir comentarios a nuestro código para facilitar la lectura y comprensión del mismo, tanto por otros programadores, como por nosotros mismos.
Comentar el código es algo muy simple, que se tarda muy poco en hacer y que sin embargo marca una gran diferencia al comprenderlo. Un comentario debe ser breve, conciso y decriptivo, destacando lo relevante de un fragmento concreto de código, por ejemplo, qué dato almacena una variable, que función realiza un método específico (los métodos los trataremos más adelante) o simplemente información adicional como el autor / autores del código, la fecha en que se ha escrito o de qué versión del programa se trata.
Básicamente consiste en añadir al código un texto escrito en lenguaje natural por nosotros mismos. Esto se puede hacer de dos formas: comentando una única línea, o varias a la vez.
Comentario en una sola línea: Se escribe // e indica que todo lo que aparezca en la misma línea, a la derecha de la doble barra, será comentario y por tanto no debe ser interpretado como código por el compilador.
Comentario en más de una línea: Se abre con /* y se cierra con */. Todo lo que esté encerrado entre la apertura y el cierre, pudiendo estar estos en líneas diferentes, será interpretado como comentario y por tanto el compilador no lo entenderá como parte del programa. Cada línea que añadamos tendrá que comenzar por *.
Ejemplos:
Si te ha gustado esta publicación, te sugiero que te suscribas al blog haciendo clic en el botón de la cabecera de la página para no perderte las próximas publicaciones. También estoy en las redes sociales.
Twitter: @NacionPC
Instagram: @nacionpc
Comentarios
Publicar un comentario