A la hora de programar se suele tener la mala costumbre de no comentar lo que se escribe. Esto se suele deber a varios motivos:
- Escribes código que solo crees que leerás tú. Y das por supuesto que lo entenderás en el futuro.
- Aparentemente es fácil de entender. Tendrá sentido para ti pero para otras personas posiblemente no.
- Cuando termine ya lo comento. Esto es algo que se suele dar comento cuando termine la función, y luego se te olvida y como ya funciona para que voy a perder el tiempo en comentar
Estas son algunas causas por las cuales no se comenta y luego hacen perder el tiempo intentando saber porque hiciste ese bucle, o de donde viene ese parámetro.
Si se lo pasas a un compañero la función tan chula que hiciste, luego te preguntara que no entiende que la variable X sea igual que Z. Y perderás el tiempo explicándoselo, cuando se puede solucionar con una linea comentada.
Ya esta claro que hay que comentar lo que programamos. Pero hay que saber como comentar bien para sacar el máximo provecho y obtener la mayor información posible sobre el código que hay escrito, como el autor, la fecha, descripción de lo que hace, etc.
Como comentar bien lo comentare próximamente.
Autor Samuel José Rocha Martos.
