¿Es un "comentario divertido" una mala práctica o no? [cerrado]

37

Quiero preguntarle si agregar algunos "huevos de pascua" en la documentación original no es profesional o no. Probablemente usted ha leído el Stackoverflow sondeo para comentarios divertidos en una fuente de documentación, y se han topado personalmente en muchas de estas cosas durante mi trabajo, incluyendo gracioso (o no) cosas en documentación de la API pública (por ejemplo, esta débil BZZZTT !! 1! Lo en la documentación pública de Android, puedo dar al menos una docena más de ejemplos).

No puedo llegar a una opinión final por mí mismo, porque tengo argumentos contradictorios por mí mismo.

Argumento profesional:

Puede animar a alguien y hacer que su día sea más divertido / productivo. La mayor parte del código fuente no necesita ser comentada de todos modos (si el proyecto se realiza correctamente), porque el método específico (por ejemplo) se explica por sí mismo, o si es una pila de código extraño extraño, no puede explicarse de manera significativa, para que un chiste gracioso no dañe la posible información que puede obtener del documento.

Argumento contras:

Si está muy concentrado / frustrado, lo último que necesita es la broma estúpida de alguien, en lugar de brindarle la información que necesita sobre la parte del código documentado, puede hacerlo sentir aún más frustrado. Y la idea de cómo sería la documentación si todos comenzaran a hacerlo es horrible. Además, el tipo que escribe el chiste puede ser el único que piensa que es divertido / interesante / vale la pena perder el tiempo para leerlo.

¿Qué piensas?

source-code

— alguien
fuente

Lea las preguntas frecuentes y las pautas del sitio para hacer preguntas. Esta pregunta realmente no cumple con esas pautas.

— Walter

8

@Walter: es casi la misma pregunta que programmers.stackexchange.com/questions/50928/… , pero para comentarios divertidos en lugar de comentarios groseros, y la pregunta vinculada no está cerrada, se hizo hace un mes. No perderé tiempo discutiendo con usted que esta pregunta cumple con las preguntas frecuentes, y que está relacionada con las mejores (buenas) prácticas al escribir código.

— alguien

2

7 votos, esta Q es claramente deseada. Personalmente, no, porque me ha cabreado la "estafa" que has mencionado muchas veces, pero puedo ver los argumentos a favor de "pro", así que tengo curiosidad por saber cuál es el resultado. (Lo peor que encontré por cierto fue un programador que pensó que una foto "hilarante" de una pistola BB apuntando a un gatito con sus patas en alto debe estar en la página de inicio de todos nuestros servidores de desarrollo. Suspiro ...)

— James

@sombody - Tienes un punto, pero los comentarios divertidos no son tan propensos a que te despidan o peor, sujeto a una demanda por acoso. Consideraré cerrar la otra pregunta (no estoy seguro de haber acertado cuando se publicó).

— JeffO

1

Estoy de acuerdo en que esta publicación se vuelva a abrir, aunque no puedo votar porque no tengo el representante. El objetivo de hacer que los Programadores se separen de SO es para preguntas como esta. Además, con 22 votos para esta pregunta, la comunidad lo quiere claramente.

— RoboShop

12

Creo que los comentarios divertidos pierden tiempo: tiempo perdido para escribir, tiempo perdido para leer, tiempo perdido para mostrar a sus colegas el comentario divertido que (casi siempre) es simplemente desconcertante, etc.

Pero ... en realidad, nadie trabaja al 100% todo el día todos los días (sitios como este estarían vacíos si lo hiciéramos) y el humor genuino rompe el día y ayuda a mantener la moral.

Todavía votaría en contra simplemente porque cada comentario 'gracioso' que he leído puede haber sido muy gracioso en ese momento, pero aún no he visto uno que sea realmente gracioso, la mayoría son simplemente desconcertantes o son profundos -broma.

Si los comentarios divertidos fueran realmente divertidos, cambiaría de opinión. Pero una vez que fomentas bromas, ¿fomentas palabrotas, insultos o malicia?

— amelvin
fuente

55

+1 Solo lees esos comentarios cuando tienes que arreglar algo y no tienen sentido en ese momento y cuando corriges los errores, ciertamente no estás de humor para ver la "broma inteligente" de otro desarrollador sobre el tema. En lugar de perder tiempo pensando en una broma, por favor, dedique un tiempo a un código más claro, corrija un error, etc. Además, ¿qué sucede con la 'broma' si algo se refactoriza?

— Jan_V

2

Así que es como el humor en el espacio de la carne: más vale que sea divertido y que no sea TODO lo que hagas.

— Dan Ray

1

+1 inteligente, siempre y cuando no haga daño. Poner stop() //hammertimeen cada instancia de parada no es divertido.

— brillante

@glasnt, ese es un comentario realmente divertido, pero irritaría en la iteración 2, ¡y cada vez más irritaría!

— amelvin

Permitir humor en los comentarios es perfectamente aceptable. ¿Por qué una industria ya seca, seca y sin humor? Permitir palabrotas, insultos o malicia es un asunto completamente diferente. Mi experiencia ha sido totalmente diferente a la tuya. Muchas veces me reí entre dientes leyendo comentarios informativos que exhibían un ingenioso sentido del humor. Me hizo el día mejor. Se necesita algo de inteligencia para tener buen gusto en el humor, pero si se puede hacer con madurez, tráelo.

— JBeck

71

Soy un gran fanático de los comentarios graciosos .

Siempre debe ser profesional en sus comentarios, pero algo de humor no matará al lector.

Especialmente si el lector es miembro de su equipo.

Lo que más me disgusta son los desarrolladores que se toman demasiado en serio. Creo que deberíamos divertirnos en el trabajo, o el trabajo no merece la pena.

99

+1 Para "Profesional pero divertido"

— deworde

La programación en sí misma es divertida :)

— Gopi

2

@Sri Kumar: Desafortunadamente, no siempre. :(

— Bobby

1

@Bobby: ¡entonces toma la decisión de hacerlo divertido! Si no te dejan, ve y lleva tu felicidad a una empresa que se lo merece.

3

+1 por no tomarte demasiado en serio.

— JeffO

8

Si tiene significado, está bien ser divertido. Explicar algo en un comentario de una manera divertida está bien. Sin embargo, si solo es algo divertido y no contiene ningún valor real como comentario, eso es simplemente molesto. Siempre tenga en cuenta que la razón de los comentarios es hacer que el mantenimiento sea más eficiente. El humor no tiene que entrar en conflicto con eso, pero podría hacerlo si no se hace adecuadamente.

— Brian Knoblauch
fuente

Hay un comentario en el código de manejo de errores de un programa crítico: "La vida es una _ y luego mueres". Al final de la explicación. Es divertido y tiene sentido.

— Michael K

1

@ Michael - Ese es un ejemplo perfecto de lo que creo que es un desperdicio. No es divertido (ser otra repetición de una declaración muy antigua y cansada) y no agrega nada de valor.

— Brian Knoblauch

8

El código está destinado a leer ... muchas veces.

¿Cuántos chistes sabes que son divertidos después de la centésima cuenta?

@ Thorbjørn Ravn Andersen: ¿qué pasa con las caricaturas de Dilbert que imprime y fija en la pared de su cubículo? ;)

@Pierre, si encuentra un solo Dilbert adecuado para poner un comentario en el código fuente, hágamelo saber.

@ Thorbjørn Ravn Andersen: no Dilbert, pero este merecía el espacio que toma: i.imgur.com/tu7Fd.jpg

@Pierre, en realidad considero que la redacción de ese póster supera el límite y no es graciosa, pero ese es otro asunto. ¿Cuántos más tienes?

@ Thorbjørn Ravn Andersen: ese es el único

7

Los comentarios graciosos son geniales.

Le da una vibra positiva a su código aparentemente aburrido.
Si tienes tu tiempo correcto, explica mucho mejor que un comentario aburrido normal. Por "sincronización" aquí me refiero a la relevancia para el código debajo del comentario.
Muchos recordarán su código porque las emociones tienen un lugar mejor en la memoria (humana). Este es un gran truco si quieres que más chicos trabajen contigo en un proyecto de código abierto.
Generalmente útil en las revisiones. Hace que su código sea mucho más soportable. Por supuesto, primero debes concentrarte en escribir un buen código. Siento que cuando uno confía en el código que escribe, los comentarios divertidos son solo un efecto secundario.

Simplemente no seas gracioso como este chico ;)

— Reno
fuente

6

Aquí hay uno que escribí a las dos de la mañana ("DQ" son las iniciales de mi compañía):

// Twas the night before go-live and all through DQ
// the devs were all crying and yes, this means you.
// Keys had been saved with both hyphens and 'scores
// which left this programmer with finger pad sores.
// The solution I crafted, you'll likely find lacking:
// to OR them together with judicuous hacking.

$hyphenated = str_replace('_','-',$data_type_key);
$underscored = str_replace('-','_',$data_type_key);
// (and then see line 46)

— Dan Ray
fuente

3

Sí, es probable que tales cosas ocurran a las 2 AM, pero no creo que sea una buena broma: alguien después de que usted tenga que leer 6 líneas de texto si quiere ver el comentario de 2 líneas de fuente. La misma proporción que tener que leer 600 líneas de ensayo que explican 200 líneas de código

— alguien el

55

Oh, la eficiencia estaba por la ventana. Este proyecto ya era un clúster, ya sabes, un poco de ligereza contribuyó en gran medida a la moral de las 2 a.m. Si te das cuenta, el código que estoy escribiendo aquí es para evitar la negligencia de otra persona, que fue más o menos de lo que se trataron las últimas dos semanas de la marcha de la muerte. No apruebo este tipo de cosas como una práctica habitual, pero confieso que estaba bastante satisfecho con esta.

— Dan Ray

En esa situación, yo también estaría bastante complacido

— alguien el

No ponga números de línea, use "buscar <lo que sea>" en lugar de <lo que sea> es en sí mismo un comentario.

— Vinko Vrsalovic

3

Si estuviera revisando su código fuente frente al cliente, ¿se sentiría avergonzado?

Ninguna de las respuestas actuales parece tener eso en cuenta. Algunos clientes no tienen sentido del humor y tomarán los chistes como un indicador de que no se toma en serio su trabajo. Inferirán que eres descuidado con tu trabajo.

Los comentarios divertidos de código a veces pueden ser poco profesionales e inapropiados.

— M. Dudley
fuente

3

Más allá de lo que ya se dijo, si está trabajando en un equipo internacional, es posible que algunos de sus colegas extranjeros no entiendan el chiste, ya sea por algunas referencias culturales locales o por el juego de algunas palabras que no entiende alguien para quien el inglés no es el idioma nativo. . Lo mismo se aplica para proyectos de código abierto.

— vartec
fuente

2

Si es eficiente y no pierde el tiempo de los lectores (en lectura / comprensión), entonces no veo ningún problema con un poco de humor.

— jonners99
fuente

2

Al igual que los chistes en el mundo real, si los haces todo el tiempo no es divertido, ni productivo, ni profesional. Pero hay una hora y un lugar para todos los chistes, y hay una hora y un lugar en el código. Al igual que en el mundo real, es saber dónde, cuándo y cómo hacer el chiste.

— James Bedford
fuente

1

Depende, para las tareas en la universidad, casi siempre hacía comentarios divertidos, ya que sabía que nunca se usarían y es solo una tarea.

Para proyectos más serios, todavía los usaría aquí y allá, pero no tan frecuentes, por lo que es molesto o difícil de entender, desafiando el propósito del comentario.

Recuerdo que hice un poco de programación web, donde tuve que esquivar incompatibilidades del navegador y fallas extrañas. A veces terminaba en comentarios llenos de ira y odio en los .jsarchivos.

Mi regla básica es: si es algo obvio lo que hace la sección de código, ¡LOS COMENTARIOS DIVERTIDOS SE ENCIENDEN!

Si el código es tan oscuro y confuso como el infierno (como la " clase en línea "), será mejor que use comentarios que me entenderé en un par de días ...

— polemon
fuente