Comentários  Código Limpo   Capítulo 4
Comentários● “Don’t comment bad code—rewrite it.”;● Se precisa de comentários, revise o código e  tente expressá-lo atravé...
Cuidados● Vida útil do comentário;  ○ Comentário que não é atualizado juntamente com as    mudanças que ocorrem no código....
ComentáriosComentários Compensam   um Código Ruim// Verifica se o funcionário tem direito a todos os                     b...
E onde o comentário é BOM?● Questões legais; (Direitos autorais)● Comentários informativos;    ○ Funções    ○ Patterns● Ex...
Comentários Ruins ● Murmúrios;
Comentários Ruins●
Comentários Ruins● Comentários enganadores;  Criam confusão em relação a função docódigo.● Comentários imperativos;
Comentários Ruins● Comentários longos;  Deve-se evitar códigos muitos longos
Comentários Ruins● Comentários ruidosos;
Comentários Ruins● Marcadores de posição;● Comentários nas chaves de fechamento;
Comentários Ruins● Créditos de autoria
Comentários Ruins●   Explicar código em comentários;●   Comentários HTML;●   Informações não locais;●   Informações excess...
Dúvidas!           ?
Próximos SlideShares
Carregando em…5
×

Código limpo: Comentários

837 visualizações

Publicada em

Publicada em: Tecnologia
0 comentários
0 gostaram
Estatísticas
Notas
  • Seja o primeiro a comentar

  • Seja a primeira pessoa a gostar disto

Sem downloads
Visualizações
Visualizações totais
837
No SlideShare
0
A partir de incorporações
0
Número de incorporações
1
Ações
Compartilhamentos
0
Downloads
17
Comentários
0
Gostaram
0
Incorporações 0
Nenhuma incorporação

Nenhuma nota no slide

Código limpo: Comentários

  1. 1. Comentários Código Limpo Capítulo 4
  2. 2. Comentários● “Don’t comment bad code—rewrite it.”;● Se precisa de comentários, revise o código e tente expressá-lo através dele;● Fontes de imprecisão
  3. 3. Cuidados● Vida útil do comentário; ○ Comentário que não é atualizado juntamente com as mudanças que ocorrem no código.● Localização do comentário;
  4. 4. ComentáriosComentários Compensam um Código Ruim// Verifica se o funcionário tem direito a todos os beneficios if ((empregado.flags & HOURLY_FLAG) && (empregado.age > 65)) if (empregado.isElegivelParaTodosBeneficios)
  5. 5. E onde o comentário é BOM?● Questões legais; (Direitos autorais)● Comentários informativos; ○ Funções ○ Patterns● Explicação da Intenção;● Esclarecimento;(assertTrue(a.compareTo(a) == 0); //a==a)● Alerta sobre consequências;● Comentário TODO;● Destaque;● JavaDoc e outras APIs.
  6. 6. Comentários Ruins ● Murmúrios;
  7. 7. Comentários Ruins●
  8. 8. Comentários Ruins● Comentários enganadores; Criam confusão em relação a função docódigo.● Comentários imperativos;
  9. 9. Comentários Ruins● Comentários longos; Deve-se evitar códigos muitos longos
  10. 10. Comentários Ruins● Comentários ruidosos;
  11. 11. Comentários Ruins● Marcadores de posição;● Comentários nas chaves de fechamento;
  12. 12. Comentários Ruins● Créditos de autoria
  13. 13. Comentários Ruins● Explicar código em comentários;● Comentários HTML;● Informações não locais;● Informações excessivas;● Conexões não obvias;● Cabeçalhos de funções;● Java docs em códigos não públicos;
  14. 14. Dúvidas! ?

×