Un código bien comentado no solo te es útil a ti mismo cuando lo leas dentro de 3 meses, también para los demás.
Un código hay que comentarlo como si fuese algo nuevo o algo que no recuerdas, especialmente si al leerlo te haces alguna de las siguientes preguntas: ¿Cuando se utiliza esto? ¿Por qué se utiliza esto? ¿Cómo lo hace?
Para conseguirlo, dos opciones:
* Cuando se está empezando y se llena todo de TODO: (hay que hacer esto) y FIXME: (arréglame). Cuando se finalice cada uno de ellos, convertir el TODO o FIXME en un comentario normal.
* Cuando se ha acabado, haz como si tuvieras memoria de pez y lee el código de nuevo, o espera a que se te olvide (alrededor de 3 meses) y léelo entonces.
En cuanto te hagas a ti mismo una pregunta sobre el código, apúntala, esa pregunta necesita un comentario. O si programas con otros, que otros lean el código y si se hacen alguna pregunta, esa pregunta necesita un comentario.
Y si cuando vuelvas a leer el código con los comentario te siguen quedando dudas, mejora los comentarios.
Copyleft Ender. El presente artículo no tiene finalidad informativa, de creación de opinión pública o de entretenimiento. Tiene como finalidad principal, la enseñanza y la divulgación de experiencias, proyectos, pensamientos y conocimientos del autor. Se permite la copia textual, la traducción y la distribución de este artículo entero en cualquier medio, a condición de que este aviso sea conservado. Se permite la cita. El autor no reclamará ninguna cantidad por el ejercicio de las dos autorizaciones anteriores. No autorizo a ninguna Entidad de Derechos de Autor a reclamar cantidad alguna en mi nombre por el ejercicio de los dos derechos anteriores.