Comentarios en el código
Lunes, 25 de Mayo de 2009
No soy partidario de que los programas se hacen estén llenos de comentarios sin justificación en su codificación.
Debo confesar que el que mas uso es el famosismo “Aquí me quedé”. Lo uso para darme cuenta donde es exactamente la parte de código en la que seguiré trabajando al volver de comer, de una junta o el día siguiente si es que ya terminó la jornada laboral. Aquí una lista de otros comentarios bastantes graciosos de los cuales mas de uno me los he encontrado alguna vez en el trabajo.
Me siento ignorado
1 | // a veces creo que el compilador ignora todos mis comentarios |
Sinceridad
1 | // estoy borracho, lo arreglo después |
Un poco de magia
1 | // Mágico. No tocar. |
Por si no se entiende
1 | return 1; //retorna 1 |
Dios, ayúdanos
1 2 | // Cuando escribí esto sólo Dios y yo sabíamos lo que hace. // Ahora, sólo Dios sabe. |
Aviso
1 2 3 4 5 6 7 8 | /* * Quizás creas que sabés lo que hace esta porción de código. * Creeme, no lo sabés. * Si tratás de entenderlo vas a pasar muchos horas sin dormir, * maldiciendo el momento que pensaste que eras los suficientemente * inteligente para "optimizar" el siguiente código. * Así que, cerrá este archivo y andá a jugar con otra cosa. */ |
Advertencia para al mantenedor
1 2 3 4 5 6 7 8 9 10 | // // Querido mantenedor: // // Una vez que termines de intentar "optimizar" esta rutina, // y que te des cuenta del terrible error que cometiste, // por favor incrementa el siguiente contador como una // advertencia para el próximo: // // total_de_horas_gastadas_aqui = 16 // |
Desconfiar de la documentación
1 2 3 4 5 6 | /** * Siempre devuelve true. */ public boolean isAvailable() { return false; } |
Arreglo
1 | // no estoy seguro de que esto funcione, pero resuelve el problema |
Vía: DosIdeas