O “comentário engraçado” é uma prática ruim ou não? [fechadas]

37

Quero perguntar se a adição de alguns "ovos de páscoa" na documentação de origem não é profissional ou não. Provavelmente você já leu o StackOverflow pesquisa para comentários engraçados em uma documentação de origem, e eu pessoalmente tenho tropeçou em muitas coisas durante a minha trabalho, incluindo engraçado (ou não) o material na documentação da API pública (por exemplo, esta fraca BZZZTT !! 1! Coisa na documentação pública do Android, posso dar pelo menos uma dúzia de mais exemplos).

Não posso chegar a uma opinião final por mim mesma, porque tenho argumentos contraditórios por mim mesma.

Pro argumento:

  • Pode animar alguém e tornar seu dia mais divertido / produtivo. Grande parte do código-fonte não precisa ser comentada de qualquer maneira (se o projeto for feito corretamente), porque o método específico (por exemplo) é auto-explicativo ou, se for uma pilha de códigos ruins, não pode ser explicado de maneira significativa, para que uma piada engraçada não prejudique as informações possíveis que você pode obter no documento.

Contras argumento:

  • Se você está muito concentrado / frustrado, a última coisa que precisa é da piada estúpida de alguém, em vez de fornecer as informações necessárias sobre a parte do código documentado, isso pode deixá-lo ainda mais frustrado. E a idéia de como seria a documentação se todo mundo começar a fazer isso é horrível. Além disso, o cara que escreve a piada pode ser o único que acha engraçado / interessante / que vale a pena perder tempo para lê-la.

O que você acha?

source-code alguém
fonte
Leia as Perguntas frequentes e as diretrizes do site para fazer perguntas. Esta pergunta realmente não atende a essas diretrizes.
22411 Walter
8
@ Walter: é praticamente a mesma pergunta que programmers.stackexchange.com/questions/50928/… , mas para comentários engraçados, em vez de palavrões, e a pergunta vinculada não está fechada, feita há um mês. Não vou perder tempo discutindo com você que esta pergunta atende às perguntas frequentes e que está relacionada às melhores (boas) práticas ao escrever código.
alguém
2
7 votos, este Q é claramente desejado. Pessoalmente, não, porque fiquei chateado com o "golpe" que você mencionou muitas vezes, mas posso ver os argumentos do "profissional", por isso estou curioso para saber qual é o resultado. (O pior que eu encontrei na btw foi um programador que achou que uma foto "hilária" de uma pistola BB apontando para um gatinho com as patas levantadas deve estar na página inicial de todos os nossos servidores de desenvolvimento. Suspiro ...)
James
@sombody - Você tem razão, mas comentários engraçados não são tão propensos a demiti-lo ou pior, sujeitos a uma ação de assédio. Considerarei encerrar a outra pergunta (não tenho certeza se estava certo quando foi postada.).
22411 JeffO
11
Concordo que este post deve ser reaberto, embora não possa votar porque não tenho o representante. O objetivo de separar os programadores do SO é para questões como essa. Além disso, com 22 votos para esta pergunta, é claramente desejado pela comunidade.
RoboShop 25/05

Respostas:

12

Penso que comentários engraçados desperdiçam tempo - desperdiçam tempo para escrever, desperdiçam tempo para ler, desperdiçam tempo para mostrar aos colegas a observação engraçada que é (quase sempre) apenas intrigante e assim por diante.

Mas ... ninguém trabalha 100% o dia todo todos os dias (sites como esse estariam vazios se o fizéssemos) e o humor genuíno interrompe o dia e ajuda a manter o moral.

Eu ainda votaria contra isso simplesmente porque todo comentário "engraçado" que eu já li pode ter sido hilário na época - mas ainda não vi um que seja realmente engraçado, a maioria é apenas intrigante ou profundo. -gracejo.

Se comentários engraçados fossem realmente engraçados, isso mudaria de idéia. Mas uma vez que você incentiva piadas, você encoraja palavrões, insultos ou maldade?

amelvin
fonte
5
+1 Você só lê esses comentários quando precisa consertar alguma coisa e eles não fazem nenhum sentido e, ao corrigir os erros, você certamente não está disposto a ver a "piada inteligente" de outro desenvolvedor sobre o assunto. Em vez de gastar tempo pensando em uma piada, por favor, dedique algum tempo a um código mais claro, corrija um erro etc. Além disso, o que acontece com a 'piada' se algo for refatorado?
Jan_V
2
Então, é como o humor no espaço de carnes: é melhor ser engraçado e melhor não ser TUDO o que você faz.
Dan Ray
11
+1 inteligente, desde que não cause danos. Colocar stop() //hammertimeem todos os casos de parada não é engraçado.
glasnt
@glasnt - esse é um comentário genuinamente engraçado - mas isso irrita a iteração 2 e aumenta cada vez mais!
Amelvin 22/03
Permitir humor nos comentários é perfeitamente aceitável. Por que tornar uma indústria já seca e sem humor? Permitir xingamentos, insultos ou maldade é uma questão totalmente diferente. Minha experiência foi totalmente diferente da sua. Eu ri muitas vezes lendo comentários informativos que exibiam um senso de humor espirituoso. Isso fez o meu dia melhor. É preciso alguma inteligência para ter bom gosto no humor de alguém, mas se isso puder ser feito com maturidade, leve-o adiante.
JBeck
71

Eu sou um grande fã de comentários engraçados .

Você deve sempre ser profissional nos seus comentários, mas um pouco de humor não mata o leitor.

Especialmente se o leitor for um membro de sua equipe.

O que eu mais não gosto, são desenvolvedores que se levam muito a sério. Acho que devemos nos divertir no trabalho, ou o trabalho não vale a pena.


fonte
9
+1 Para "Professional but Funny"
deworde 22/03
A programação é em si divertido :)
Gopi
2
@ Sri Kumar: Infelizmente, nem sempre. :(
Bobby
11
@ Bobby: tome a decisão de torná-lo divertido, então! Se eles não deixarem, traga sua felicidade a uma empresa que a merece.
3
+1 por não se levar muito a sério.
JeffO 22/03
8

Se tiver significado, é bom ser engraçado. Explicar algo de um comentário de uma maneira divertida é bom. No entanto, se é apenas algo engraçado e não contém nenhum valor real como comentário, isso é apenas irritante. Lembre-se sempre de que o motivo dos comentários é tornar a manutenção mais eficiente. O humor não precisa entrar em conflito com isso, mas pode, se não for feito adequadamente.

Brian Knoblauch
fonte
Há um comentário no código de tratamento de erros de um programa crítico: "A vida é um _ e então você morre". no final da explicação. É engraçado e faz sentido.
Michael K
11
@ Michael - Esse é um exemplo perfeito do que eu acho que é um desperdício. Não é engraçado (sendo mais uma repetição de uma afirmação muito antiga e cansada) e não acrescenta nada de valor.
precisa
8

O código é para leitura ... muitas vezes.

Quantas piadas você sabe que são engraçadas depois da centésima contagem?


fonte
@ Thorbjørn Ravn Andersen: e os desenhos animados de Dilbert que você imprime e fixa na parede do seu cubículo? ;)
@ Pierre, se você encontrar um único Dilbert adequado para inserir um comentário no código-fonte, informe-me.
@ Thorbjørn Ravn Andersen: não Dilbert, mas este merecia o espaço que é preciso: i.imgur.com/tu7Fd.jpg
@ Pierre, na verdade, considero o texto desse pôster acima do limite e não é engraçado, mas isso é outra questão. Quantos mais você tem?
@ Thorbjørn Ravn Andersen: esse é o único #
7

Comentários engraçados são ótimos.

  • Ele dá uma vibração positiva ao seu código aparentemente chato.
  • Se você acertar o tempo . É muito melhor explicar do que um comentário chato normal faria. Por 'tempo' aqui, quero dizer a relevância para o código abaixo do comentário.
  • Seu código será lembrado por muitos, porque as emoções recebem um lugar melhor na memória (humana). Esse é um ótimo truque se você quiser que mais pessoas trabalhem com você em um projeto de código aberto.
  • Geralmente útil em comentários. Isso torna seu código muito mais suportável. Claro que você deve primeiro se concentrar em escrever um bom código. Sinto que quando alguém está confiante com o código que escreve, comentários engraçados são apenas um efeito colateral.

Só não seja engraçado como esse cara ;)

Reno
fonte
6

Aqui está um que escrevi às duas da manhã ("DQ" são as iniciais da minha empresa):

// 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
fonte
3
Sim, é provável que essas coisas ocorram às 2 horas da manhã, mas não acho que seja uma boa piada - alguém depois que você precisar ler 6 linhas de texto se quiser ver o comentário para 2 linhas de origem. A mesma proporção que ter que ler 600 linhas de ensaio que explica 200 linhas de código
alguém
5
Oh, a eficiência estava fora da janela. Esse projeto já era um cluster-you-know-what, um pouco de leveza foi um longo caminho para o moral das 2h. Se você notar, o código que estou escrevendo aqui é para contornar a negligência de outra pessoa, que era basicamente o que tratavam as últimas duas semanas da marcha da morte. Eu não tolero esse tipo de coisa como uma prática regular, mas confesso que fiquei bastante satisfeito com isso.
Dan Ray
Nessa situação, eu ficaria muito satisfeito também
alguém
Não insira números de linha, use "procurar <qualquer que seja>" em vez de <qualquer que seja> um comentário.
Vinko Vrsalovic 26/06
3

Se você estivesse revendo seu código-fonte na frente do cliente, ficaria envergonhado?

Nenhuma das respostas atuais parece levar isso em consideração. Alguns clientes não têm senso de humor e consideram as piadas como um indicador de que você não leva seu trabalho a sério. Eles deduzirão que você é descuidado com seu trabalho.

Às vezes, comentários engraçados sobre códigos podem ser pouco profissionais e inadequados.

M. Dudley
fonte
3

Além do que já foi dito, se você estiver trabalhando em equipe internacional, alguns de seus colegas estrangeiros podem não entender a piada, porque algumas das referências culturais locais ou algumas palavras são interpretadas por alguém para quem o inglês não é o idioma nativo . O mesmo se aplica a projetos de código aberto.

vartec
fonte
2

Se for eficiente e não desperdiçar o tempo dos leitores (na leitura / compreensão), não vejo problema com um pouco de humor.

jonners99
fonte
2

Assim como as piadas do mundo real, se você as faz o tempo todo, não é engraçado, nem produtivo nem profissional. Mas há uma hora e um lugar para todas as piadas, e há uma hora e um lugar no código. Assim como no mundo real, é saber onde, quando e como fazer a piada.

James Bedford
fonte
1

Depende, para tarefas na faculdade, eu quase sempre fazia comentários engraçados, pois sabia que nunca seriam usados ​​e é apenas uma tarefa de casa.

Para projetos mais sérios, eu ainda os usaria aqui e ali, mas não como predominantes, para que seja irritante ou difícil de entender, desafiando o objetivo do comentário.

Lembro-me de fazer um pouco de programação na Web, onde tive que evitar incompatibilidades no navegador e falhas estranhas. Às vezes, terminava em comentários cheios de raiva e ódio nos .jsarquivos.

Minha regra básica é: se é algo óbvio o que a seção de código faz, COMENTÁRIOS ENGRAÇADOS LIGAM!

Se o código é tão obscuro e ofuscante como o inferno (como a " classe inline "), é melhor eu usar comentários. Vou me entender daqui a alguns dias ...

polemon
fonte