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

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?

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?

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.

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.

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

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

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

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)

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.

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.

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.

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.

Ç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 ...