Comentarios en el código como una forma de autoexpresión

Recientemente, al elegir un marco no muy popular, me encontré con el siguiente código.


¡Porque los robots asesinos aman los unicornios!

No sé qué pensamiento y con qué humor quería transmitir el autor, pero esto me llevó a pensar: ¿con qué frecuencia usamos los comentarios no exactamente para su propósito previsto? Algunos hallazgos debajo del corte.

  // No se recomienda leer si no te gustan las publicaciones de los viernes y los martes. 

Hay diferentes opiniones sobre el tema de los comentarios de código. Hay adherentes del código autoexplicativo. Según este concepto, las variables y funciones se nombran lo más completamente posible, lo que en muchos casos elimina la necesidad de escribir comentarios adicionales. Otros prefieren describir cada paso en los comentarios para ayudarse a sí mismos y a aquellos que luego tendrán que trabajar con el código. Algunos escriben construcciones de 3 pisos en una línea y no los comentan de ninguna manera (él mismo pecó, lo admito). Pero hay otros casos.

Triste confesión


¿Alguna vez has escrito algo por lo que tú mismo odiaste? ¿Entendiste que hacerlo es malo y feo, pero las circunstancias (requisitos del cliente, por ejemplo) fueron más fuertes que tú? Algo de esto sucedió.

  // Este código apesta, lo sabes y yo lo sé.
 // Sigue adelante y llámame idiota más tarde. 

Este código es asqueroso, lo sabes y yo lo sé. Sigue adelante, luego llámame idiota.

  // No soy responsable de este código.
 // Me hicieron escribirlo, en contra de mi voluntad. 

No soy responsable de este código. Me vi obligado a escribir esto en contra de mi voluntad.

  // Tengo que encontrar un trabajo mejor 

Es hora de encontrar un mejor trabajo.

  // Dedico todo este código, todo mi trabajo, a mi esposa, Darlene, quien 
 // tengo que apoyarme a mí, a nuestros tres hijos y al perro una vez que se pone 
 // lanzado al público. 

Dedico todo este código, todo mi trabajo, a mi esposa Darlene, que tendrá que cuidar de mí, nuestros tres hijos y el perro, tan pronto como vea la luz del día.

Y a veces los estándares corporativos para escribir código lo obligan a hacer algo que no se presta a la lógica interna del desarrollador.

  const int TEN = 10;  // Como si el valor de 10 fluctuara ... 

Como si el valor 10 puede variar ...

Recordé el caso cuando obtuve un pequeño trabajo en un directorio en freelance. El sistema de interacción se creó de manera compleja, como resultado de lo cual no hubo comentarios directos del cliente. Y era necesario hacer "como en la imagen, porque el cliente lo aprobó", aunque esto era feo desde el punto de vista del código. ¿Te has encontrado con estos también?

Advertencias y conocimiento perdido


Sucede que es mejor no interferir con algún código. No intente refactorizarlo, optimizarlo o mejorarlo.

 / * * Puede pensar que sabe lo que hace el siguiente código.  * Pero no lo haces.  Confía en mi  * Juegue con él y pasará muchas noches sin dormir * maldiciendo el momento en que pensó que sería inteligente * lo suficiente como para "optimizar" el código a continuación.  * Ahora cierra este archivo y ve a jugar con otra cosa.  * / 

Puede parecerle que sabe lo que hace el código posterior. Esto no es asi. Confía en mi Métete en él y pasarás muchas noches sin dormir maldiciendo el momento en que creías que eras lo suficientemente inteligente como para "optimizarlo". Ahora cierra este archivo y ve a jugar con otra cosa.

  / *
  * Estimado mantenedor
  * *
  * Una vez que haya terminado de tratar de "optimizar" esta rutina,
  * y te has dado cuenta del terrible error que fue,
  * incremente el siguiente contador como advertencia
  * al siguiente chico.
  * *
  * total_hours_wasted_here = 73
  * / 

Estimado acompañante! Cuando haya terminado su intento de "optimizar" este proceso y se haya dado cuenta de lo monstruoso que fue este error, aumente el contador posterior como una advertencia para aquellos que vienen por usted.

  // Magia.  No tocar 

La magia No tocar

  / *
 después de horas de consultar el tomo de google
 He descubierto que por voluntad de fuerzas desconocidas
 sin la línea de abajo, IE7 cree que 6px = 12px
 * /
 tamaño de fuente: 0px; 

Después de horas de consulta y búsqueda en Google, descubrí que por voluntad de fuerzas desconocidas sin una línea posterior, IE7 cree que 6px = 12px

  // Autogenerado, NO edite.  Todos los cambios se deshacerán. 

Generado automáticamente, NO edite. Todos los cambios serán descartados.

Este último, por cierto, es un ejemplo interesante de inteligencia en la lucha contra los intentos de ingresar a su código. Dicen que funciona.

Dolor y desesperación


¿Tuviste que trabajar con algo que te llevó a la desesperación total? El desarrollador del visor de imágenes Xee ha encontrado el análisis del formato PSD. ¿Pero con quién puede un programador compartir sus sufrimientos, si no con un comentario? A continuación hay una traducción, el original está actualmente en el github .

Aquí me gustaría parar por un momento y hablar sobre el formato Adobe PSD. PSD no es un buen formato. PSD ni siquiera es un mal formato. Llamarlo sería un insulto a otros formatos malos, como PCX o JPEG. No, PSD es un formato monstruoso. Varias semanas de trabajo en este código han elevado mi odio a la PSD al nivel de un fuego feroz, que arde con la feroz pasión de un millón de soles.

Si hay dos formas de hacer algo, el PSD usa ambas en diferentes lugares. Además, creará tres formas más que no se le habrían ocurrido a ninguna persona sensata, y las usará al mismo tiempo. PSD lleva inconsistencia al nivel del arte. ¿Por qué, por ejemplo, decidió que estos bloques deberían estar alineados por cuatro bytes, y esta alineación no debería incluirse en el tamaño? Otros bloques en otros lugares no se alinean o incluyen alineación en tamaño. Aquí, sin embargo, no está incluido. Cualquiera de estas tres formas funcionaría. Un formato razonable se centraría en uno. PSD, por supuesto, usa los tres y otros.

Intentar extraer datos de un archivo PSD es como buscar algo en el ático de su excéntrico tío viejo que murió por el ataque de un frenético tiburón de agua dulce en su 58 cumpleaños. El último detalle no es particularmente significativo para la narración, pero en este momento paso mucho tiempo presentando destinos interesantes para las personas responsables de este Ruba Goldberg entre los formatos de archivo.

Anteriormente, intenté obtener las últimas especificaciones de formato PSD. Para hacer esto, tuve que recurrir a ellos para obtener permiso para recurrir a ellos para considerar la posibilidad de enviarme este volumen sagrado. El proceso incluyó enviarles por fax copias de ciertos documentos, posiblemente firmados con sangre. La única explicación que me viene a la mente es la complejidad del proceso: están extremadamente avergonzados de la creación de esta abominación. Naturalmente, no pude realizar este procedimiento, pero si pudiera, imprimiría todo en una sola página de esta especificación y los grabaría. Si estuviera en mi poder, recogería todas las copias de la especificación en el mundo y les enviaría un cohete directamente al Sol.

PSD no es mi formato favorito.

No llegué a tal nivel de odio, pero recordé cómo me sangraban los ojos al leer documentación para la API de algunos desarrolladores nacionales.

Manera de entretenerte


Sabemos lo aburrido y solitario que es el trabajo de un programador. Porque todos a veces interpretamos a la misma persona en KVN. La forma más segura de hacerlo es en los comentarios, por supuesto, pero hay opciones.

  #Inicializador de árbol de navidad  
     toConnect = []  
     toRead = []  
     toWrite = []   
     primos = []  
     respuestas = {}  
     restante = {} 

Árbol de navidad inicializador

  /////////////////////////////////////// esta es una línea bien comentada 

Línea bien comentada

  Repetir
     ...
 Hasta que (JesúsCristesReturn) 'No estoy seguro 

Dogma religioso en duda ...

  // si alguna vez vuelvo a ver esto, voy a comenzar a poner armas a trabajar 

Una vez más, veré esto: comenzaré a llevar armas para trabajar

  // Abandona toda esperanza que entras más allá de este punto 

Renunciar a la esperanza de que todos vengan aquí

  // borracho, arreglo después 

Borracho arreglado después

Bromeaba como una broma, y ​​una vez me dejé una nota similar en una pegatina en el monitor: "Sobrio, mira las clases XXX, YYY" ...

  captura (Excepción e) {
  // a quien le importa?
 } 

A quien le importa

  // No entiendo cómo funciona el siguiente bit, pero funcionó en el programa del que lo robé. 

No sé cómo funciona esta pieza, pero funcionó en el programa, desde donde la robé.

  // Este código fue escrito por un genio, así que no intentes entenderlo con
 // tu pequeño y pequeño cerebro. 

Este código está escrito por un genio. No intentes entenderlo con tu cerebro en miniatura.

  doble penetracion;  // ouch 

Y realmente, oh ...

  // Agregado porque el jefe cambió de opinión: 20020111,20020501,20020820, ...
 // Comentó porque el jefe cambió de opinión: 20020201,20020614,20020908, ... 

Agregado desde el jefe cambió de opinión ... Comentó, porque el jefe cambió de opinión ...

  // ¡Aleluya, puedo irme a casa! 

Aleluia, puedo irme a casa

Me fui a casa Y nos dices cuál fue tu comentario más memorable o divertido.

Gracias por quedarte con nosotros. ¿Te gustan nuestros artículos? ¿Quieres ver más materiales interesantes? Apóyenos haciendo un pedido o recomendándolo a sus amigos, un descuento del 30% para los usuarios de Habr en un análogo único de servidores de nivel de entrada que inventamos para usted: toda la verdad sobre VPS (KVM) E5-2650 v4 (6 núcleos) 10GB DDR4 240GB SSD 1Gbps de $ 20 o cómo dividir el servidor? (las opciones están disponibles con RAID1 y RAID10, hasta 24 núcleos y hasta 40GB DDR4).

Dell R730xd 2 veces más barato? ¡Solo tenemos 2 x Intel Dodeca-Core Xeon E5-2650v4 128GB DDR4 6x480GB SSD 1Gbps 100 TV desde $ 249 en los Países Bajos y los Estados Unidos! Lea sobre Cómo construir un edificio de infraestructura. clase utilizando servidores Dell R730xd E5-2650 v4 que cuestan 9,000 euros por un centavo?

Source: https://habr.com/ru/post/es420091/


All Articles