Download - Código limpo: Comentários
![Page 1: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/1.jpg)
ComentáriosCódigo Limpo
Capítulo 4
![Page 2: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/2.jpg)
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
![Page 3: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/3.jpg)
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;
![Page 4: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/4.jpg)
Comentários
Comentá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)
![Page 5: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/5.jpg)
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 API's.
![Page 6: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/6.jpg)
Comentários Ruins
● Murmúrios;
●
![Page 7: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/7.jpg)
Comentários Ruins
●
![Page 8: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/8.jpg)
Comentários Ruins
● Comentários enganadores;Criam confusão em relação a função do
código.● Comentários imperativos;
![Page 9: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/9.jpg)
Comentários Ruins
● Comentários longos;Deve-se evitar códigos muitos longos
![Page 10: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/10.jpg)
Comentários Ruins
● Comentários ruidosos;
![Page 11: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/11.jpg)
Comentários Ruins
● Marcadores de posição;
● Comentários nas chaves de fechamento;
![Page 12: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/12.jpg)
Comentários Ruins
● Créditos de autoria
![Page 13: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/13.jpg)
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;
![Page 14: Código limpo: Comentários](https://reader034.vdocuments.site/reader034/viewer/2022052223/55731fecd8b42aae7b8b4c38/html5/thumbnails/14.jpg)
Dúvidas!
?