Perguntas sobre como escrever comentários no código.
Muitas pessoas afirmam que "os comentários devem explicar 'por que', mas não 'como'". Outros dizem que "o código deve ser auto-documentado" e os comentários devem ser escassos. Robert C. Martin afirma que (reformulado com minhas próprias palavras) frequentemente "os comentários são desculpas por...
Um dos membros da minha equipe evita consistentemente fazer comentários em seu código. Seu código não é auto-documentado, e outros programadores têm dificuldade em entender seu código. Pedi-lhe várias vezes para comentar seu código, no entanto, ele apenas dá desculpas ou afirma que o fará mais...
Eu trabalhei em lojas que produzem softwares críticos para a vida e lidei com as regras de comentários destinadas a manter o código legível e potencialmente salvar vidas. Na minha experiência, embora o requisito se torne uma tarefa de morte encefálica a ser excluída de uma lista de verificação e...
Um colega meu acredita que qualquer uso de comentários no código (ou seja, não método de estilo javadoc ou comentários de classe) é um cheiro de código . O que você
desenvolvedor júnior aqui. Atualmente, estou trabalhando sozinho em um aplicativo da web para um grande cliente da minha empresa. Comecei no mês passado. O cliente deseja pelo menos 25% dos comentários em cada um de seus projetos de software. Eu verifiquei o código de aplicativos anteriores e...
Estou trabalhando em um projeto bastante grande e tive a tarefa de fazer algumas traduções para ele. Havia toneladas de etiquetas que não foram traduzidas e, enquanto eu vasculhava o código, encontrei esse pequeno pedaço de código //TODO translations Isso me fez pensar sobre o sentido desses...
Eu escrevi o seguinte código: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl());
Estou tendo algumas discussões com meus novos colegas sobre comentários. Nós dois gostamos de Clean Code , e estou perfeitamente bem com o fato de que os comentários de código em linha devem ser evitados e que os nomes de classe e métodos devem ser usados para expressar o que eles fazem. No...
Eu sei que o Subversion (o que estamos usando no trabalho) pode ser configurado para exigir comentários em confirmações, no entanto, não estou em posição de poder para simplesmente ativá-lo. Sei que meu motivo para comentar meus commits é porque é útil, mesmo que apenas como um ativador de memória,...
Primeiro de tudo, nesta pergunta, eu gostaria de ficar longe da polêmica sobre se o comentário do código fonte é bom ou ruim. Estou apenas tentando entender mais claramente o que as pessoas querem dizer quando falam sobre comentários que dizem por que, o que ou como. Muitas vezes, vemos diretrizes...
Estou sendo ensinado pelo meu chefe (eu terminei a escola e ele queria alguém com um pouco de experiência em programação, então ele me escolheu para me treinar no que a empresa é especializada) e começou a trabalhar com aplicativos ASP.NET MVC , alguns HTML e CSS . Eu estou bem com o material de...
O que as pessoas geralmente querem dizer sempre que você vê XXXum comentário. Ocasionalmente, vejo um comentário como este: # XXX - This widget really should frobulate the whatsit Claro, posso dizer o que o comentário significa, mas o que o XXX geralmente significa? Está dizendo "Isso é um hack"...
Acabei de escrever o seguinte comentário em algum código (arcaico do Visual Basic 6.0) que estava escrevendo: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Não sei por que subconscientemente uso "nós" em meus comentários. Eu suspeito que é...
fundo Estou trabalhando em uma equipe que procura implementar implantações com tempo de inatividade zero. Planejamos usar uma estratégia de implantação azul / verde para conseguir isso. Uma das coisas que estou percebendo ao fazer a pesquisa é como fica complicado fazer alterações no banco de...
Alguém disse uma vez que deveríamos prefixar todos os nossos métodos com os /// <summary>blocos de comentários (C #), mas não explicou o porquê. Comecei a usá-los e descobri que eles me incomodavam um pouco, então parei de usá-los, exceto para bibliotecas e métodos estáticos. Eles são...
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...
É 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...
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...
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 /** */para...
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...