Perguntas com a marcação «comments»

Foi-nos pedido que adicionássemos comentários com as tags de início, fim, descrição, solução, etc., para cada alteração que fizermos no código como parte da correção de um bug / implementação de um CR. Minha preocupação é: isso oferece algum valor agregado? No momento, temos todos os detalhes no histórico de …

42 version-control  bug  comments  change 

É uma boa prática colocar números de bug no próprio arquivo dentro de um comentário de cabeçalho? Os comentários ficariam assim: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Parece útil, mas …

40 version-control  development-process  source-code  comments 

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 

Ao longo da programação, você terminará com alguns comentários que explicam o código e outros que estão removendo o código: // A concise description const a = Boolean(obj); //b = false; Existe um bom método para analisar rapidamente qual é qual? Eu brinquei com o uso de 3 /e /** …

38 javascript  comments 

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 

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 

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 …

27 language-agnostic  comments 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 5 anos . Vi isso perguntado no SO Tavern , então estou …

27 source-code  comments  coding-style  grammar 

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 …

26 coding-style  comments 

Fechado . Esta questão é baseada em opiniões . No momento, não está aceitando respostas. Deseja melhorar esta pergunta? Atualize a pergunta para que ela possa ser respondida com fatos e citações editando esta postagem . Fechado há 4 anos . Estou apenas começando com a programação funcional e estou …

25 functional-programming  comments 

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 

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 …

22 coding-standards  comments 

Sempre que descubro que grande parte do meu código precisa ser alterada, seja porque está incorreta ou porque precisa ser adaptada às principais mudanças arquiteturais necessárias por outros motivos, é o que normalmente faço: Comento todo o código que suspeito que possa ter que ser alterado. Trato o código comentado …

21 anti-patterns  comments 

Esta pergunta foi migrada do Stack Overflow porque pode ser respondida no Software Engineering Stack Exchange. Migrou há 7 anos . Comentar hoje em dia é mais fácil do que nunca. Em Java, existem algumas boas técnicas para vincular comentários a classes, e os Java IDEs são bons em criar …

20 java  python  clojure  comments 

Em alguns projetos de código aberto, reuni o seguinte estilo de codificação void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Eu sempre tenho dúvidas sobre o que falsesignifica aqui. Isso significa "esquecer" ou "esquecer" se refere ao parâmetro correspondente (como no caso acima), e "false" significa negá-lo? …

19 coding-style  comments  boolean