Principaux commentaires dans le code source

Salut, Habrovsk. Je n’ai pas encore beaucoup écrit ici, mais j’ai réussi à essayer plusieurs formats d’articles. Voici des entretiens avec des informaticiens de l'entreprise dans laquelle je travaille, des traductions, des guides ... Quelque chose est entré, quelque chose n'a pas fonctionné. Et donc, aujourd'hui, j'ai décidé d'essayer un nouveau format pour moi.



Dans mon temps libre, j'aime parfois m'asseoir sur Quora - je réponds aux questions des autres participants, ou je lis simplement les réponses aux questions intéressantes. L'autre jour, je suis tombé sur une question plutôt populaire. Le fil compte plus d'un millier d'abonnés et plus de 100 réponses. Et la question est: quel est le meilleur commentaire que vous avez vu dans le code source? (Orig. Quel est le meilleur commentaire dans le code source que vous ayez jamais rencontré?)

Je sais qu'il y a de tels threads sur stackoverflow et reddit, mais depuis J'ai été inspiré par les réponses de Quora, j'ai décidé de faire une sélection à partir de là. J'ai parcouru la plupart des réponses et choisi le couple qui est venu le plus souvent.

Réponse de Costya Perepelitsa


Meilleur commentaire que j'ai jamais vu, probablement, Safety Pig ( Security Pig ):



Je n'ai jamais été entièrement sûr de la façon dont il était censé m'aider dans le traitement du code, mais quoi qu'il en soit, cela a fonctionné.

Par conséquent, nous avons inclus Safety Pig dans notre processus de débogage et d'amélioration de la sécurité:
«La structure de ce code rend particulièrement difficile la détection des fuites de mémoire. Ajoutez un Pig de sécurité et envoyez vos modifications via Valgrind avant chaque validation. »
«Le compilateur ne peut pas assurer la sécurité des types ici, nous avons donc ajouté Safety Pig au cas où.»
"Je n'ai pas encore de tests unitaires, mais je leur ai ajouté un porc." (presque travaillé)

Pour ceux d'entre vous qui voudraient avoir leur propre cochon de sécurité, ignorez la première ligne. Les blocs de code Quora suppriment automatiquement les espaces de tête dans la première ligne.

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

Réponse de Sasha Krassovsky


Une fois que je regardais le code source de certains jeux d'étudiants aléatoires que j'ai trouvés sur DigiPen quand j'ai soudainement vu ceci:

/* Do NOT delete this comment */

Naturellement, j'ai dû voir ce qui se passe si je supprime le commentaire. Je l'ai supprimé et j'ai essayé de recompiler. N'a pas marché. Quand j'ai renvoyé le commentaire, il s'est compilé comme par magie.

Il y avait une erreur LNK1000: "erreur inconnue; Consultez la documentation pour les options de support technique. " Pourquoi ce commentaire était nécessaire restera à jamais un mystère.

Répondre par Rishi Kumar


Le meilleur que j'ai vu est dans un programme compliqué:

1. //Fu*k whoever wrote this shit

Et puis, après environ cinq lignes, ceci:

//oh god it was me

Réponse de Chen Xu


Une fois que j'ai vu ça:


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 statue de Bouddha bénit votre code pour être exempt de bugs. En rire pendant un moment.

D'après une réponse de Somnath Mishra


Il était une fois j'ai vu un fil similaire sur Stackoverflow et j'ai partagé certains des commentaires les plus drôles que j'ai rencontrés. Oui, j'ai moi-même écrit beaucoup de commentaires drôles, mais je ne les partagerai pas ici pour des raisons évidentes.

Ce commentaire n'est pas seulement amusant, mais brillant. Certaines personnes abandonnent leurs rêves littéraires lorsqu'elles travaillent en tant que programmeurs:

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

(voie. Remplace les espaces entre parenthèses aux endroits où ils provoquent la stase)
Cela semble impressionnant en anglais - deux lignes de commentaires, et il y a 6 rimes en eux.

Un peu d'humour noir:

1. double penetration; // ouch

Le code peut faire d'une personne un athée:

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!

Lors du nettoyage de l'ancien code, les programmeurs rencontrent souvent des parties qui ne sont pas utilisées, mais ne les suppriment pas, de peur des conséquences possibles:

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

Programmeur agacé:

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

(voie. Je ne suis pas responsable de ce code. Ils m'ont forcé à l'écrire contre ma volonté)

Programmeur en colère:

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

Conclusion


Le fil avait encore beaucoup de choses intéressantes, vous pouvez tout lire en anglais ici . En général, si ce post arrive, je pense que plus tard je recueillerai une liste des commentaires les plus intéressants qui ont été trouvés dans ma pratique. Et lesquels avez-vous rencontrés? Je serai heureux de lire dans les commentaires.

All Articles