Blogia
el agujero de gusano

Niveles de documentación del código

Haciendo mis prácticas de poo me acuerdo de una historia que leí hace tiempo en barrapunto sobre cómo la gente comenta el código de sus programas. Aquí va un ejemplo:

Nivel 1: (El adecuado)
for (i=0;i=n;i++){
p(mutex); //Aquí bloqueo el proceso mediante un semáforo...
[...]

Nivel 2: (El que se pasa un poco)
for (i=0;i=n;i++){ //Aquí hago un bucle, con una variable i que vá de 0 a 10
p(mutex); //Aquí bloqueo el proceso mediante un semáforo...
[...]

Nivel 3: (El meta-comentario)
for (i=0;i=n;i++){ //Aquí hago un bucle, con una variable i que vá de 0 a 10 //En este comentario explico lo que hace el for
p(mutex); //Aquí bloqueo el proceso mediante un semáforo...
[...]


Vale, es un chiste friki y sin gracia. Y hablando de meta (ir más allá), no pude publicar la noticia tal como la escribí por querer hablar de un lenguaje con otro lenguaje. ¿Alguien sabe por qué? (Abstenganse de romperse la cabeza quienes no sepan C/Java y html)

0 comentarios