Perguntas com a marcação «comments»

Perguntas sobre como escrever comentários no código.



12
Comentários desatualizados são um mito urbano?
Vejo constantemente pessoas afirmando que "os comentários tendem a ficar desatualizados". Acho que já vi dois ou três comentários desatualizados em toda a minha carreira. Informações desatualizadas em documentos separados acontecem o tempo todo, mas, na minha experiência, comentários desatualizados no próprio código são extremamente raros. Acabei de ter sorte …
38 comments  myth 


13
Comentário antes ou depois do código relevante [fechado]
Supondo que um comentário não se encaixe (ou não possa ir) na linha a que se aplica, deve-se escrever o comentário antes do código ou depois? Bem, sempre que futuros leitores entenderem melhor o escopo do comentário. Em outras palavras, onde quer que a maioria dos programadores / roteiristas coloque …
34 comments 

5
Como os comentários geralmente são analisados?
Como os comentários são geralmente tratados em linguagens de programação e marcação? Estou escrevendo um analisador para alguma linguagem de marcação personalizada e quero seguir o princípio da menor surpresa , então estou tentando determinar a convenção geral. Por exemplo, um comentário incorporado em um token 'interfere' com o token …
31 parsing  comments 

6
Guia do iniciante para escrever comentários?
Deseja melhorar este post? Forneça respostas detalhadas para esta pergunta, incluindo citações e uma explicação de por que sua resposta está correta. Respostas sem detalhes suficientes podem ser editadas ou excluídas. Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 8 …


9
Estilo e recomendações do código de comentários
Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 8 anos . Quero ouvir de você algum conselho e experiência em escrever comentários em seu código. Como você os escreve da maneira mais fácil e informativa? Que hábitos você tem ao …


6
Como resolver o problema de comentários aninhados
Aparece em não apenas um idioma que os comentários não podem ser aninhados. Você tem uma boa solução para este problema? Uma solução alternativa em C / C ++ e Java é usar apenas o comentário de linha única, mas torna-se impossível comentar um bloco maior. Estou enfrentando algo assim: …
23 java  c++  python  c  comments 

21
Vs. código de auto-documentação. Código comentado
Bloqueado . Os comentários sobre esta pergunta foram desativados, mas ainda estão aceitando novas respostas e outras interações. Saiba mais . Eu fiz uma pesquisa, mas não encontrei o que estava procurando. Sinta-se à vontade para me vincular se esta pergunta já tiver sido feita. No início deste mês, este …




Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.