Comentarios principales en el código fuente

Hola habrovsk Todavía no he escrito mucho aquí, pero pude probar varios formatos de artículos. Aquí hubo entrevistas con algunos especialistas de TI de la compañía en la que trabajo, traducciones, guías ... Algo entró, algo no. Y así, hoy decidí probar un nuevo formato para mí.



En mi tiempo libre a veces me gusta sentarme en Quora: respondo preguntas de otros participantes o simplemente leo respuestas a preguntas interesantes. El otro día me encontré con una pregunta bastante popular. El hilo tiene más de mil suscriptores y más de 100 respuestas. Y la pregunta es: ¿cuál es el mejor comentario que has visto en el código fuente? (Orig. ¿Cuál es el mejor comentario en el código fuente que haya encontrado?)

Sé que existen tales hilos en stackoverflow y reddit, pero desde Me inspiraron las respuestas de Quora, decidí hacer una selección desde allí. Revisé la mayoría de las respuestas y elegí a la pareja que más apareció.

Respuestas de Costya Perepelitsa


El mejor comentario que he visto, probablemente, Safety Pig ( Security Pig ):



nunca he estado completamente seguro de cómo se suponía que me ayudaría en el procesamiento del código, pero sea lo que sea, funcionó.

Como resultado, incluimos Safety Pig como parte de nuestro proceso de depuración y mejora de seguridad:
“La forma en que está estructurado este código hace que sea especialmente difícil detectar pérdidas de memoria. Agregue un cerdo de seguridad y envíe sus cambios a través de Valgrind antes de cada confirmación ".
"El compilador no puede proporcionar seguridad de tipo aquí, así que agregamos Safety Pig por si acaso".
"Todavía no tengo pruebas unitarias, pero les agregué un cerdo". (casi trabajado)

Para aquellos de ustedes que deseen tener su propio cerdo de seguridad, ignoren la primera línea. Los bloques de código de Quora eliminan automáticamente los espacios iniciales en la primera línea.

1. .
2.                         _
3. _._ _..._ .-',     _.._(`))
4.'-. `     '  /-._.-'    ',/
5.   )         \            '.
6.  / _    _    |             \
7. |  a    a    /              |
8. \   .-.                     ;  
9.  '-('' ).-'       ,'       ;
10.     '-;           |      .'
11.        \           \    /
12.        | 7  .__  _.-\   \
13.        | |  |  ``/  /`  /
14.       /,_|  |   /,_/   /
15.          /,_/      '`-'

Respuesta de Sasha Krassovsky


Una vez que estaba mirando el código fuente de algunos juegos de estudiantes al azar que encontré en DigiPen cuando de repente vi esto:

/* Do NOT delete this comment */

Naturalmente, tenía que ver qué pasa si borro el comentario. Lo eliminé e intenté recompilar. No funcionó. Cuando devolví el comentario, se compiló como por arte de magia.

Hubo un error LNK1000: "error desconocido; Consulte la documentación para ver las opciones de asistencia técnica ". Por qué este comentario fue necesario seguirá siendo para siempre un misterio.

Respuestas de Rishi Kumar


Lo mejor que he visto es en un programa complicado:

1. //Fu*k whoever wrote this shit

Y luego, después de unas cinco líneas, esto:

//oh god it was me

Respuesta de Chen Xu


Una vez que vi esto:


1. //
2. //                       _oo0oo_
3. //                      o8888888o
4. //                      88" . "88
5. //                      (| -_- |)
6. //                      0\  =  /0
7. //                    ___/`---'\___
8. //                  .' \\|     |// '.
9. //                 / \\|||  :  |||// \
10.   //             / _||||| -:- |||||- \
11.   //            |   | \\\  -  /// |   |
12.   //            | \_|  ''\---/''  |_/ |
13.   //            \  .-\__  '-'  ___/-. /
14.   //          ___'. .'  /--.--\  `. .'___
15.   //       ."" '<  `.___\_<|>_/___.' >' "".
16.   //      | | :  `- \`.;`\ _ /`;.`/ - ` : | |
17.   //      \  \ `_.   \_ __\ /__ _/   .-` /  /
18.   //  =====`-.____`.___ \_____/___.-`___.-'=====
19.   //                       `=---='
19.   //
20.   //
21.   //  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.  //
23.  //            God Bless         No Bugs
24.  //

La estatua de Buda bendice tu código para estar libre de errores. Riéndose de eso por un rato.

De una respuesta de Somnath Mishra


Érase una vez un hilo similar en Stackoverflow y compartí algunos de los comentarios más divertidos que encontré. Sí, yo mismo escribí muchos comentarios divertidos, pero no los compartiré aquí por razones obvias.

Este comentario no es solo divertido, sino brillante. Algunas personas abandonan sus sueños literarios cuando trabajan como programadores:

1. // Replaces with spaces the braces in cases where braces
2. // in places cause stasis                                                           
3. $str = str_replace(array("\{","\}")," ",$str);

(carril. Reemplaza los espacios entre paréntesis en aquellos lugares donde causan estasis)
Suena impresionante en inglés: dos líneas de comentarios y hay 6 palabras que riman en ellas.

Un poco de humor negro:

1. double penetration; // ouch

El código puede hacer que una persona sea atea:

1. //When I wrote this, only God and I understood what I was doing    
2. //Now, God only knows                                                  
3. // Update: I am an atheist now!

Al limpiar el código antiguo, los programadores a menudo encuentran partes que no se usan, pero que no eliminan, por temor a posibles consecuencias:

1. // I am not sure if we need this, but too scared to delete.

Programador molesto:

1. // I am not responsible of this code.
2. // They made me write it, against my will.

(carril. No soy responsable de este código. Me obligaron a escribirlo en contra de mi voluntad)

Programador enojado:

1. // no comments for you
2. // it was hard to write
3. // so it should be hard to read

Conclusión


El hilo todavía tenía muchas cosas interesantes, puedes leer todo en inglés aquí . En general, si aparece esta publicación, creo que más tarde recopilaré una lista de los comentarios más interesantes que se encontraron en mi práctica. ¿Y cuáles has conocido? Estaré encantado de leer en los comentarios.

All Articles