Est-ce que "commenter drôle" est une mauvaise pratique ou pas? [fermé]


37

Je tiens à vous demander si l'ajout de "œufs de Pâques" dans la documentation source n'est pas professionnel ou non. Vous avez probablement lu le StackOverflow sondage des commentaires drôles dans une documentation source, et j'ai personnellement trébuché à beaucoup de ces choses pendant mon travail, y compris des choses drôles (ou non) dans la documentation de l' API publique (par exemple , ce faible BZZZTT !! 1! Chose dans la documentation publique Android, je peux donner au moins une douzaine d’autres exemples).

Je ne peux pas me prononcer moi-même, car j’ai des arguments contradictoires.

Pro argument:

  • Cela peut remonter le moral de quelqu'un et rendre sa journée plus amusante / plus productive. De toute façon, il n’est pas nécessaire de commenter la majeure partie du code source (si le projet est correctement exécuté), car la méthode spécifique (par exemple) est explicite, ou s’il s’agit d’une pile de code étrange, elle ne peut pas être expliqué de manière significative, donc une blague amusante ne nuit pas aux informations que vous pouvez obtenir du doc.

Argument contre:

  • Si vous êtes très concentré / frustré, la dernière chose dont vous avez besoin est la blague stupide de quelqu'un. Au lieu de vous donner les informations dont vous avez besoin sur la portion de code documentée, cela peut vous rendre encore plus frustré. Et l’idée de ce à quoi ressemblerait la documentation si tout le monde le faisait est horrible. De plus, le type qui écrit la blague est peut-être le seul à penser que c'est drôle / intéressant / qu'il vaut la peine de perdre du temps à la lire.

Qu'est-ce que tu penses?


Veuillez lire la FAQ du site et les directives pour poser des questions. Cette question ne répond vraiment pas à ces directives.
Walter

8
@Walter: c'est à peu près la même question que programmers.stackexchange.com/questions/50928/… , mais pour les commentaires amusants au lieu des commentaires profanes, et la question liée n'est pas fermée, posée il y a un mois. Je ne perdrai pas de temps à discuter avec vous que cette question répond à la FAQ et qu'elle est liée aux meilleures (bonnes) pratiques lors de l'écriture de code.
quelqu'un

2
7 votes, ce Q est clairement recherché. Personnellement, je ne pense pas avoir été énervé par le "con" dont vous avez parlé à plusieurs reprises, mais je peux voir les arguments en faveur de "pro", alors je suis curieux de savoir quel en sera le résultat. (Le pire que j'ai rencontré était d'ailleurs un programmeur qui pensait qu'une photo "hilarante" d'un pistolet BB montrant un chaton avec ses pattes levées devait se trouver sur la page d'accueil de tous nos serveurs de développeurs. Sigh ...)
James

@sombody - Vous avez raison, mais les commentaires amusants ont moins de chances de vous faire virer ou, pire encore, de faire l'objet d'une poursuite en harcèlement. Je vais envisager de clore l’autre question (je ne suis pas sûre que c’était exact quand elle a été affichée.).
JeffO

1
Je suis d'accord pour que ce message soit ré-ouvert, bien que je ne puisse pas voter car je n'ai pas le représentant. Faire en sorte que les programmeurs soient séparés des SO est destiné à des questions comme celle-ci. De plus, avec 22 votes pour cette question, il est clairement recherché par la communauté.
RoboShop

Réponses:


12

Je pense que ces commentaires amusants font perdre du temps - temps perdu à écrire, à lire, à montrer à vos collègues la remarque amusante qui est (presque toujours) simplement déroutante, etc.

Mais ... personne ne travaille réellement à 100% toute la journée (des sites comme celui-ci seraient vides si nous le faisions) et un véritable humour brise la journée et contribue à maintenir le moral.

Je voterais toujours contre tout simplement parce que tous les commentaires «drôles» que j'ai jamais lus ont peut-être été hilarants à l'époque - mais je n'ai pas encore vu de commentaire vraiment drôle, la plupart sont simplement énigmatiques ou profonds. -blague.

Si des commentaires amusants étaient réellement amusants, cela me changerait la tête. Mais une fois que vous encouragez les plaisanteries, encouragez-vous les jurons, les insultes ou la malveillance?


5
+1 Vous ne lisez ces commentaires que lorsque vous devez réparer quelque chose et que cela n'a aucun sens. Lorsque vous corrigez des bogues, vous n'êtes certainement pas d'humeur à voir la "blague" intelligente d'un autre développeur sur le sujet. Au lieu de penser à une blague, pensez plutôt à clarifier le code, à corriger un bogue, etc. Et que se passe-t-il avec la «blague» si quelque chose est refactorisé?
Jan_V

2
C'est donc comme l'humour dans l'espace à manger: mieux vaut être drôle et mieux vaut ne pas être TOUT ce que vous faites.
Dan Ray

1
+1 intelligent, tant qu'il ne fait pas de mal. Mettre stop() //hammertimeà chaque instance d'arrêt n'est pas drôle.
Glasnt

@glasnt - c'est un commentaire vraiment amusant - mais cela irrite à la seconde itération et irrite de plus en plus par la suite!
Amelvin

Permettre l'humour dans les commentaires est parfaitement acceptable. Pourquoi rendre une industrie déjà sèche sèche ET sans humour? Permettre des jurons, des insultes ou des malveillances est une toute autre affaire. Mon expérience a été totalement différente de la vôtre. J'ai souvent ri en lisant des commentaires informatifs montrant un sens de l'humour plein d'esprit. Cela a rendu ma journée meilleure. Il faut de l'intelligence pour être de bon goût dans l'humour, mais si cela peut se faire avec maturité, amenez-le.
JBeck

71

Je suis un grand fan de commentaires amusants .

Vous devriez toujours être professionnel dans vos commentaires, mais un peu d'humour ne tuera pas le lecteur.

Surtout si le lecteur est un membre de votre équipe.

Ce qui me déplaît le plus, ce sont les développeurs qui se prennent trop au sérieux. Je pense que nous devrions nous amuser au travail, ou le travail n'en vaut pas la peine.


9
+1 pour "professionnel mais drôle"
deworde

La programmation est amusante :)
Gopi

2
@ Sri Kumar: Malheureusement, pas toujours. :(
Bobby

1
@Bobby: prenez la décision de vous amuser alors! S'ils ne vous le permettent pas, allez apporter votre bonheur à une entreprise qui le mérite.

3
+1 pour ne pas te prendre trop au sérieux.
JeffO

8

Si cela a un sens, ça va être drôle. Expliquer quelque chose de façon amusante dans un commentaire est acceptable. Cependant, si ce n'est que quelque chose de drôle et ne contient aucune valeur réelle en tant que commentaire, c'est tout simplement ennuyeux. Gardez toujours à l'esprit que la raison des commentaires est de rendre la maintenance plus efficace. L'humour n'a pas à entrer en conflit avec cela, mais pourrait le faire si ce n'est pas fait correctement.


Il y a un commentaire dans le code de traitement d'erreur d'un programme critique: "La vie est un _ et vous mourrez." à la fin de l'explication. C'est drôle et ça a du sens.
Michael K

1
@ Michael - C'est un exemple parfait de ce que je pense est un gaspillage. Ce n'est pas drôle (encore une répétition d'une déclaration très ancienne et fatiguée) et n'ajoute rien de valeur.
Brian Knoblauch

8

Le code est destiné à la lecture ... plusieurs fois.

Combien de blagues connaissez-vous qui sont drôles après le centième raconter?


@ Thorbjørn Ravn Andersen: Qu'en est-il des dessins animés Dilbert que vous imprimez et épinglez sur le mur de votre box? ;)

@Pierre, si vous trouvez un seul Dilbert apte à insérer un commentaire dans le code source, faites-le moi savoir.

@ Thorbjørn Ravn Andersen: pas Dilbert, mais celui-ci méritait l'espace qu'il prend: i.imgur.com/tu7Fd.jpg

@Pierre, en fait, j’estime que le libellé de cette affiche dépasse la limite et n’est pas drôle, mais c’est une autre affaire. Combien en avez-vous?

@ Thorbjørn Ravn Andersen: c'est le seul

7

Les commentaires amusants sont géniaux.

  • Cela donne une ambiance positive à votre code apparemment ennuyeux.
  • Si votre timing est correct, il expliquera beaucoup mieux qu’un commentaire ennuyeux normal. Par "timing", j'entends ici la pertinence du code sous le commentaire.
  • Beaucoup se souviendront de votre code, car les émotions occupent une meilleure place dans la mémoire (humaine). C'est un bon truc si vous voulez que plus de gars travaillent avec vous sur un projet open source.
  • Généralement utile dans les commentaires. Cela rend votre code beaucoup plus supportable. Bien sûr, vous devriez d’abord vous concentrer sur l’écriture d’un bon code. Je pense que lorsque l’on a confiance dans le code qu’il écrit, les commentaires amusants ne sont qu’un effet secondaire.

Ne sois pas drôle comme ce mec ;)


6

En voici une que j'ai écrite à deux heures du matin ("DQ" correspond aux initiales de mon entreprise):

// 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)

3
Oui, de telles choses vont probablement se produire à 2 heures du matin, mais je ne pense pas que ce soit une bonne blague - quelqu'un après vous doit lire 6 lignes de texte s'il veut voir le commentaire sur 2 lignes de source. Le même ratio que d'avoir à lire 600 lignes de texte qui explique 200 lignes de code
quelqu'un

5
Oh, l'efficacité était à la fenêtre. Ce projet constituait déjà une telle grappe-vous-savez-quoi, un peu de légèreté a beaucoup contribué au moral de 2 heures du matin. Si vous remarquez que le code que j'écris ici vise à éviter la négligence de quelqu'un d'autre, ce qui était à peu près ce dont il était question dans les deux dernières semaines de la marche de la mort. Je ne tolère pas ce genre de chose en tant que pratique régulière, mais j'avoue que je suis assez satisfait de celui-ci.
Dan Ray

Dans cette situation, je serais très heureux aussi
quelqu'un

Ne mettez pas de numéros de ligne, utilisez plutôt "rechercher <tout>" où <tout> est lui-même un commentaire.
Vinko Vrsalovic

3

Si vous examiniez votre code source devant le client, seriez-vous gêné?

Aucune des réponses actuelles ne semble en tenir compte. Certains clients n’ont aucun sens de l’humour et considèrent les blagues comme un signe que vous ne prenez pas votre travail au sérieux. Ils vont en déduire que vous êtes négligent dans votre travail.

Les commentaires de code amusants peuvent parfois être non professionnels et inappropriés.


3

Au-delà de ce qui a déjà été dit, si vous travaillez en équipe internationale, certains de vos collègues d'outre-mer risquent de ne pas comprendre la blague, car l'une ou l'autre des références culturelles locales ou des jeux de mots qui ne sont pas compris par quelqu'un pour qui l'anglais n'est pas la langue maternelle . La même chose s'applique aux projets open source.


2

Si c'est efficace et ne perd pas le temps du lecteur (en lecture / compréhension), alors je ne vois pas de problème avec un peu d'humour.


2

Tout comme les blagues dans le monde réel, si vous les faites tout le temps, ce n'est pas drôle, pas productif, et pas professionnel. Mais il y a un temps et un lieu pour toutes les blagues, et il y a un temps et un lieu dans le code. Comme dans le monde réel, il faut savoir où, quand et comment faire la blague.


1

Ça dépend, pour les devoirs au collège, je faisais presque toujours des commentaires amusants, car je savais que ça ne serait jamais utilisé et que ce n’était qu’un devoir.

Pour des projets plus sérieux, je les utiliserais encore ici et là, mais moins fréquemment, ce qui est ennuyeux ou difficile à comprendre, défiant le but du commentaire.

Je me souviens de faire un peu de programmation Web, où je devais éviter les incompatibilités de navigateur et les problèmes étranges. Cela finissait parfois par des commentaires pleins de rage et de haine dans les .jsdossiers.

Ma règle de base est la suivante: si le contenu de la section de code est assez évident, vous pouvez activer les commentaires amusants!

Si le code est si obscur et obscur (comme la " classe en ligne "), je ferais mieux d'utiliser des commentaires que je comprendrai moi-même dans quelques jours ...

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.