Buenas prácticas de programación: comentarios y trazas

Los comentarios y las trazas son una ayuda inestimable que no debemos dejar de utilizar, tanto para ayudarnos a nosotros mismos como a los que nos sufren.

Los comentarios:

Publicidad
  • Sirven para describir un trozo de código y ayudarnos a comprender qué debe hacer cada parte de un programa. Es una ayuda al programador.
  • Cuando revisemos después de un tiempo un código, posiblemente no nos acordemos exactamente cómo funcionaba. Los comentarios nos ayudarán a recordarlo.
  • Si otra persona utiliza el código, los comentarios le ayudará a saber qué hace y cómo funciona.
  • Con Arduino, los comentarios son como en Java:
// este es un comentario en una línea
/* Este es un comentario
con varias líneas */
  • Si estamos realizando pruebas con nuestro código, puede que en un momento dado queramos que no se ejecute una parte para realizar una prueba. La manera más sencilla de hacer que no se ejecute es añadir “/*” al principio y “*/” al final y ¡listo! el código no se ejecuta porque lo hemos “comentado”.
// No estoy seguro de qué operación utilizar...
/*
result=a+b
result=a*b
*/
result=a-b
  • Nota sobre el comentario anterior: comenta código sólo para pruebas, no dejes código comentado en un programa terminado.
  • La parte mala: tanto los comentarios como el código deberían estar en inglés. Lo siento hispano-hablantes, hemos perdido esta batalla 🙁
// Not sure which operator I should use...
/*
result=a+b
result=a*b
*/
result=a-b
  • La parte buena: las bromas o chistes están permitidos 🙂
// Not sure what the hell I am doing...
/*
result=a+b
result=a*b
*/
result=a-b

La traza o log:

  • Sirve para saber qué está haciendo un programa (o nuestro Arduino) durante la ejecución mostrando información. Es una ayuda a la persona que utiliza el código/solución/aparato.
  • Muchas veces la única manera de saber que un programa/aparato/solución está funcionando bien es mediante su traza.
  • ¡Que sea útil! Escribe en traza lo suficiente, ni más ni menos.
    • Si escribes poca traza no sabrás qué está haciendo.
    • Si escribes demasiada traza te será difícil seguir la ejecución porque tendrás demasiada información.
    • Un buen criterio es escribir una línea de traza en cada bloque de código relevante (por ejemplo, si un trozo de código realiza una operación compleja escribir en traza el resultado).
  • Ya vimos cómo escribir traza con Arduino aquí.

Deja una respuesta

Tu dirección de correo electrónico no será publicada.

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.