En esta sección te explicamos cómo comentar líneas del código en Arduino. Los comentarios son líneas de código que no tienen ninguna función en la lógica de tu programa, simplemente se usan para comentar ciertas zonas del código.
Resumen para comentar líneas.
Cuando decimos comentario, nos referimos a una línea del código que va a ser ignorada. Solo sirve para dar instrucciones o explicar funcionamientos.
Para comentar una sola línea de código se usan dos diagonales “//”
// Este es un comentario en Arduino
Para comentar varias líneas de código se usa “/*” al inicio del comentario y para indicar donde termina se usa “*/”.
/* Un comentario * de varias * líneas * en Arduino */
Importancia de los comentarios en el código.
Comentar líneas es muy útil y se recomienda hacerlo. Claro sin exagerar, el objetivo de los comentarios es entender el código más fácilmente. O dejar tareas pendientes, para que no se te olvide que ahí tenías que hacer algo.
Si el código tiene comentarios sobre el funcionamiento de cada zona de tu programa, alguien más lo puede entender con mayor facilidad. O tú mismo, en un futuro que regreses a ver él código, con los comentarios recordarás más fácil y rápido como funciona el programa.
Puede ser tedioso, pero es una buena manera de dejar todo más claro.
Como comentar líneas de código en Arduino.
Para hacer comentarios, es decir, para escribir una línea de código que sea ignorada por la lógica de tu programa, se usan dos diagonales “//”.
Por ejemplo, en el siguiente código creamos comentarios señalando donde declaramos las variables, y donde inicializamos los pines del Arduino.
// Declaramos las variables
int a = 0;
void setup()
{
// Inicializamos los pines del Arduino
pinMode(8,OUTPUT);
}
void loop() {
// Aquí escribimos la lógica de nuestro programa
}
Señalar así el código ayuda a mantener una buena organización. No es necesario hacer comentarios en cada línea. Solo los que creamos necesarios.
Comentar bloques de código.
Es posible comentar varias líneas de código usando “/*” al inicio y “*/” al final.
Si escribimos “/*” y presionamos Enter, automáticamente se completara el bloque para comentar. Cada enter que presionemos será una nueva línea para comentar.
En el siguiente código te mostramos como hicimos un comentario de varias líneas, este lo llamamos bloque.
/*Este es un comentario
*de varias líneas.
*Se puede usar para explicar nuestro código.
*/
void setup(){
}
void loop() {
}
Cuando es necesario dar una explicación más detallada del código o de los pendientes que tenemos por hacer. Podemos usar este tipo de comentarios.