Todo buen programador sabe que aprender a programar es mucho más que escribir líneas de código. Una buena programación también requiere de planeación, una en la que se defina exactamente qué es lo que se quiere hacer en un proyecto y cuál será la mejor manera de hacerlo. Por ello, en este post, te enseñaremos por qué aprender a programar con comentarios puede ayudarte a planear mejor tus proyectos y cómo hacerlo.
¿Qué es programar con comentarios?
Cuando hablamos de aprender a programar con comentarios nos referimos a una estrategia que nos permite planificar una programación antes de empezar a escribirla en nuestro código. Para ello, primero pensamos en nuestro proyecto y definimos los pasos lógicos que debemos escribir para hacerlo posible. Esto lo haremos en formato de comentario directamente en nuestro archivo de código, preferiblemente en la sección en la que escribiríamos la acción que estamos planificando.
Dentro de aprender a programar con comentarios también encontramos una estrategia utilizada en proyectos profesionales a gran escala: los comentarios TODO. Este tipo de comentarios empiezan con los caracteres TODO y se refieren a las tareas que están pendientes en nuestro proyecto. Escribir este tipo de comentarios es muy útil cuando programamos en equipo, pues las tareas pueden dividirse. Esto, además, nos permite entender el proyecto en tareas cortas y fáciles de ejecutar, lo que reduce la sensación de que es un proyecto enorme e imposible.
¿Cómo podemos aprender a programar con comentarios?
Aprender a programar con comentarios es una práctica de todos los días, no necesariamente de un solo ejemplo teórico. Sin embargo, a continuación, te mostramos cómo usaríamos esta estrategia para ejecutar una acción compleja.
Supongamos que hemos creado una liga deportiva en la que hemos programado un sistema de todos contra todos. Es decir, hemos logrado que un array de equipos se recorra y se definan partidos en los que un equipo es local y otro es visitante. Ahora, lo que queremos es crear los partidos alternos; esto es, los mismos partidos, pero con el equipo que era local como visitante y el visitante como local. Esta función puede volverse un poco compleja. Para ello, usaremos comentarios que nos ayuden a dividir esta tarea en pequeñas acciones que sabemos cómo programar.
Entonces, lo primero que haríamos sería definir la sección en la que programaríamos esta acción, que en nuestro caso es la planificación de la liga. Luego, escribiríamos la lógica necesaria para ejecutar la acción en comentarios. A continuación, te mostramos cómo escribimos esta lógica:
// si hay más de una ronda
// para cada ronda extra
// hacemos copia de la primera ronda
// si la ronda es par
// intercambiamos los valores de visitante y local de los partidos
// guardamos la ronda en la planificaciónComo puedes ver, la idea de estos comentarios es escribir en términos de lógica, al igual que lo haríamos con los elementos, palabras clave y valores de un lenguaje de programación. De este modo, es más fácil traducir la lógica a código. Además, mantenemos la idea general de las líneas de código y las sangrías o valores indentados.
A la hora de aprender a programar con comentarios, te recomendamos ser muy descriptivo con las acciones lógicas que deben suceder. Esto hará que sea más fácil traducir las acciones de palabras a código.
Aunque esta estrategia es más útil para personas que están aprendiendo a programar, la realidad es que incluso los equipos más profesionales pueden usarla para asegurarse de entender cómo se lleva a cabo una acción antes de escribirla. Además, utilizar esta estrategia nos permite volver al código y entender su propósito más rápido, pues tenemos la guía de nuestros comentarios.
A continuación, te mostramos algunas de las líneas de código finales que hemos creado a partir de los comentarios escritos:
// si hay más de una ronda
if (this.config.rounds > 1) {
// para cada ronda extra
for (let i = 1, i < this.config.rounds; i++) {
// hacemos copia de la primera ronda
const newRound = [...this.matchDaySchedule];
// si la ronda es par
// intercambiamos los valores de visitante y local de los partidos
// guardamos la ronda en la planificación
newRound.forEach (newMatchDay => {
this.matchDaySchedule.push (newMatchDay)
}
}¿Te animas a seguir aprendiendo?
Ahora que sabes la utilidad de aprender a programar con comentarios, seguro que quieres seguir aprendiendo sobre todo lo que se relaciona con el desarrollo web. Para ello, te recomendamos nuestro Desarrollo Web Full Stack Bootcamp, donde aprenderás, entre muchas otras cosas, a desarrollar con lenguajes como JavaScript, CSS y HTML. Con KeepCoding, te convertirás en un experto en desarrollo web en tan solo unos pocos meses. ¿Te animas a seguir aprendiendo con nosotros? ¡Te esperamos!
