El otro día me comentaba un compañero que tenía un problemilla con un módulo de cierta aplicación que iba muy lento.. Lo que estaba claro es que el problema había que arreglarlo, pero claro contábamos con casi 2000 líneas de código sin comentar..
En ese momento el problema se había convertido en un rompecabezas de grandes dimensiones, el cual no era fácil de solucionar.. y no lo fue. Aún no se ha hecho pero ya perece claro que hay que tirar las 2000 lineas y empezar de cero, lo que parece que llevará menos tiempo que intentar descifrar el código.
Naturalmente este no es un problema nuevo y supongo que a la mayoría de lectores de este blog les ha pasado en unas cuentas ocasiones. Lo que si esta claro que uno de los caballos de batalla del mundo del Software sigue siendo la Calidad del Código.
No podemos llegar a ser una Ingeniería de prestigio con este retrabajo constante y con un nivel de Calidad medio-bajo, y la calidad del código son los cimientos, donde creo que España esta sinceramente a la cola.. No entiendo aún porque no le damos a esto la importancia que merece.
Después de mi típica protesta, que se llevará el viento, pero que me encanta decir de vez en cuando para quedarme a gusto, os dejo con lo que realmente ha motivado este post.
He encontrado estos 13 consejos sobre los comentarios del código en el genial blog de Variable Not Found:
1. Comenta a varios niveles
2. Usa párrafos comentados
3. Tabula por igual los comentarios de líneas consecutivas
4. No insultes la inteligencia del lector
Debemos evitar comentarios absurdos como:
if (a == 5) // Si a vale cinco, ...
counter = 0; // ... ponemos el contador a cero
...
5. Sé correcto
Evita comentarios del tipo "ahora compruebo que el estúpido usuario no haya introducido un número negativo"
comunicación, que es de lo que se trata.
6. No pierdas el tiempo
No comentes si no es necesario, ni florituras, ni chistes, ni poesías, ni chascarrillos.
7. Utiliza un estilo consistente
Hay quien opina que los comentarios deberían ser escritos para que los entendieran no programadores. Otros, en cambio, piensan que debe servir de ayuda para desarrolladores exclusivamente.
8. Para los comentarios internos usa marcas especiales
9. Comenta mientras programas
10. Comenta como si fuera para tí mismo. De hecho, lo es.
"tan pronto como una línea de código sale de la pantalla y volvemos a ella, estamos en modo mantenimiento de la misma"
11. Actualiza los comentarios a la vez que el código
12. La regla de oro del código legible: deja que tu código hable por sí mismo. Si el código es bueno.. pocos comentarios hacen falta..
13. Difunde estas prácticas entre tus colegas
Si lo queréis leer entero lo tenéis aquí...
De todos modos voy a añadir el número 14:
14: Cuando acabes de programar, mira tú código, sino sabes lo que hace.. es que esta mal comentado.. y probablemente mal programado.
