Archive for mayo, 2009

Comentando codigo

Comentando codigo

Si bien para muchos de nosotros a veces la programación resulta ser algo complicado o confuso, lo es aun mas cuando el código programado no ha sido por nosotros, es que vamos a mas de uno le ha pasado que se queda con cara de WTF! cuando vemos el código y no tenemos ni idea de que esta haciendo….

Para esto se inventaron los comentarios, enunciados que ayudan a entender porciones de código, sobre que hace, que resultados se obtienen etcétera, pero como todo, el informático estará ahi para echarlo a perder tambien xD! veamos algunos ejemplos de comentarios FAIL para programar:

Me siento ignorado.
A veces creo que el compilador ignora todos mis comentarios

Sinceridad.
Estoy borracho, lo arreglo después

Un poco de magia.
Mágico. No tocar.

Por si no se entiende.
return 1; //retorna 1

Dios, ayúdanos.
// Cuando escribí esto sólo Dios y yo sabíamos lo que hace.
// Ahora, sólo Dios sabe.

Disculpas
// lo siento.

Aviso
/*
* Quizás creas que sabes lo que hace esta porción de código.
* Créeme, no lo sabes.
* Si tratas 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 cierra este archivo y ves a jugar con otra cosa.
*/

Advertencia para al mantenedor
//
// 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
//

¡Que no ocurra!
try {
} finally { // no debería ocurrir
}

Desconfiar de la documentación
/**
* Siempre devuelve true.
*/
public boolean isAvailable() {
return false;
}

Arreglo
// no estoy seguro de que esto funcione, pero resuelve el problema

Desafio
// el código siguiente reemplaza al código anterior. ¿¿Algún problema??
// Si. No funciona.

Museo
// se mira pero no se toca

El resentido:

// Hago esto en mi último día en el trabajo

Gracias a @jd_makubex por los comentarios, agrega los tuyos, no los niegues.