[Docs] Capítulo 4 – 100 Comentários #4
Description
✅ Capítulo 4 – 100 Comentários
Nada melhor do que um comentário dizendo o óbvio.
🎯 Objetivo do Capítulo
Criticar com humor o uso excessivo ou inútil de comentários. Mostrar como maus comentários podem atrapalhar mais do que ajudar.
🔧 Formato
- Use exemplos de comentários redundantes ou enganadores.
- Inclua códigos onde o comentário contradiz o que está acontecendo.
- Finalize explicando o papel de um bom comentário.
📚 Referências
- Capítulo 4 de “Clean Code” – Comentários.
- Docusaurus Guides
✍️ Checklist para quem estiver escrevendo:
- Introdução divertida
- Exemplos de comentários inúteis
- Comentários contraditórios ao código
- Explicação técnica clara ao final
- Referência ao capítulo