Tinselcity

Comentando código

No sé si fue buena idea o no1), pero en Navidad nos juntamos en casa de mi madre a comer.

En la mesa que tiene, aunque es grande, no cabemos todos, claro. Así que tuve que sacar unos tableros y unos caballetes a modo de prolongación. Y luego… encontrar el mantel apropiado.

Manteles

Mi madre tiene una buena cantidad de manteles; propios y heredados. Unos más largos, otros más cortos, más anchos, menos. Dejando a un lado dos o tres, que se distinguen claramente por ser de color o tener algún dibujo de color, la mayoría son de algún tono de blanco y con algún motivo -en blanco también- típico como cuadros u hojas.

Todos estos manteles pasan el año guardados en cajones hasta que llega el día de usar uno de ellos. Pero… ¿Cuál es el adecuado? Para eso lleva cada uno una pequeña nota sujeta con un alfiler.

Tableros

Los tableros que usamos para prolongar la mesa han ido cambiando con los años. Porque también nosotros hemos ido cambiando con los años, claro. Otros años podían venir tías, primos, etc. También ahora hay nuevas generaciones.

Este año, tras contar cuántos seríamos, saqué dos tableros del armario. Hay otros tableros más grandes en el trastero e incluso un prolongador con sus propias patas plegables. En fin, saqué los tableros y los monté sobre los caballetes. Todo bien.

Notas

Como decía los manteles tienen unas notitas sujetas con alfileres. En las notas pone cosas como “Mesa con un tablero” o “Mesa con dos prolongadores”. En otros pone “2.75 x 1.20”. En otros puede poner otras cosas, o puede que no tengan ninguna nota porque se haya caído.

Las notas son casi perfectamente inútiles, claro. Por lo menos en esta forma. Porque “mesa con un tablero” no dice qué tablero y los hay de muy diferentes longitudes. Y además, tras tantos años, hay más de una nota de esas que tan útilmente ponen la medida, que ha cambiado accidentalmente de mantel. Así que, después de probar varios, terminé por hacer lo mismo de otros años: sacar e ir probando hasta encontrar uno que sirva, sin hacer caso a las notas.

Comentarios de código

El problema real de las notas de los manteles no es que lo que digan no tenga sentido. Estoy 100% seguro que cuando se escribió cada nota, lo que ponía tenía un sentido preciso y claro. Pero ha pasado el tiempo. Las circunstancias cambian. Aparecen nuevos tableros, desaparecen otros, se mueven los manteles de sitio, accidentalmente se intercambian notas o se pierden.

Las notas no son estrictamente necesarias. Quiero decir, al final, siempre termino encontrando el mantel que busco, claro. No íbamos a quedarnos sin comer por unos papelitos que dicen cosas inútiles. Pero, si las notas ayudaran, podría encontrarlo con mucho menos esfuerzo.

A veces me encuentro comentarios en el código que son exactamente igual que las notas de los manteles: No solo no ayudan sino que dejarse guiar por ellos lleva a un montón de confusión y de esfuerzo -mental- innecesario.

También me encuentro con quienes han decidido que, dado que esos comentarios no ayudan, la solución es no poner ningún comentario en absoluto. En cierto modo, es una solución. Por lo menos es una solución parcial. Evita que alguien haga caso a comentarios incorrectos y termine perdiendo tiempo y esfuerzo.

Pero, insisto, si las notas ayudaran, encontraríamos el mantel con mucho menos esfuerzo. Sin ninguna nota, el único recurso es hacer todo el esfuerzo, es sacar todos los manteles y probarlos hasta encontrar el buscado.

La solución no es dejar de poner comentarios en el código. La solución es poner comentarios útiles y tratarlos como se debe. Poner comentarios que tengan un significado claro. Cambiar los comentarios cuando las circunstancias cambien. Asegurarse de que los comentarios son verdaderos. Aprender a darles la utilidad que tienen y que deben tener.

1)
Mi opinión cuenta poco en estos casos