Principais comentários no código fonte

Olá, Habrovsk. Ainda não escrevi muito aqui, mas consegui experimentar vários formatos de artigos. Aqui estavam entrevistas com alguns especialistas em TI da empresa em que trabalho, traduções, guias ... Algo entrou, algo não aconteceu. E então, hoje eu decidi tentar um novo formato para mim.



No meu tempo livre, às vezes gosto de sentar no Quora - respondo perguntas de outros participantes ou apenas leio respostas a perguntas interessantes. Outro dia, me deparei com uma pergunta bastante popular. O segmento tem mais de mil assinantes e mais de 100 respostas. E a pergunta é: qual é o melhor comentário que você viu no código-fonte? (Orig. Qual é o melhor comentário no código-fonte que você já encontrou?)

Eu sei que existem esses segmentos no stackoverflow e no reddit, mas desde Fui inspirado pelas respostas do Quora, decidi fazer uma seleção a partir daí. Examinei a maioria das respostas e escolhi o casal que mais apareceu.

Responder por Costya Perepelitsa


Melhor comentário que já vi, provavelmente, Safety Pig ( Security Pig ):



nunca tive certeza de como exatamente isso deveria me ajudar no processamento do código, mas, seja o que for, funcionou.

Como resultado, incluímos o Safety Pig como parte de nosso processo de depuração e aprimoramento de segurança:
“A maneira como esse código é estruturado torna especialmente difícil detectar vazamentos de memória. Adicione um Safety Pig e faça suas alterações através do Valgrind antes de cada confirmação. ”
“O compilador não pode fornecer segurança de tipo aqui, por isso adicionamos o Safety Pig apenas por precaução.”
"Ainda não tenho testes de unidade, mas acrescentei um porco para eles." (quase funcionou)

Para aqueles de vocês que gostariam de ter seu próprio porco de segurança, ignore a primeira linha. Os blocos de código Quora removem automaticamente os espaços iniciais na primeira linha.

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

Responder por Sasha Krassovsky


Uma vez eu estava olhando o código fonte de alguns jogos aleatórios que encontrei no DigiPen quando de repente vi isso:

/* Do NOT delete this comment */

Naturalmente, eu tinha que ver o que acontece se eu excluir o comentário. Eu o apaguei e tentei recompilar. Não funcionou. Quando retornei o comentário, ele compilou como que por mágica.

Ocorreu um erro LNK1000: "erro desconhecido; Consulte a documentação para opções de suporte técnico. ” Por que esse comentário foi necessário permanecerá para sempre um mistério.

Responder por Rishi Kumar


O melhor que eu já vi é em um programa complicado:

1. //Fu*k whoever wrote this shit

E então, após cerca de cinco linhas, isso:

//oh god it was me

Responder por Chen Xu


Uma vez eu vi isso:


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

A estátua de Buda abençoa seu código para estar livre de bugs. Rindo por um tempo.

De uma resposta de Somnath Mishra


Era uma vez vi um tópico semelhante no Stackoverflow e compartilhamos alguns dos comentários mais engraçados que me deparei. Sim, eu próprio escrevi muitos comentários engraçados, mas não os compartilharei aqui por razões óbvias.

Este comentário não é apenas divertido, mas brilhante. Algumas pessoas desistem de seus sonhos literários quando trabalham como programadores:

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

(faixa. Substitui os espaços entre parênteses nos locais em que causam estase)
Parece impressionante em inglês - duas linhas de comentário, e há 6 palavras rimas nelas.

Um pouco de humor negro:

1. double penetration; // ouch

O código pode tornar uma pessoa ateu:

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!

Ao limpar o código antigo, os programadores geralmente encontram partes que não são usadas, mas não são excluídas, por medo de possíveis consequências:

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

Programador irritado:

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

(faixa. Eu não sou responsável por esse código. Eles me fizeram escrever contra minha vontade)

Programador irritado:

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

Conclusão


O tópico ainda tinha muitas coisas interessantes, você pode ler tudo em inglês aqui . Em geral, se este post aparecer, acho que mais tarde coletarei uma lista dos comentários mais interessantes encontrados em minha prática. E quais você já conheceu? Ficarei feliz em ler nos comentários.

All Articles