
É muito comum encontrar artigos e livros sobre boas práticas de código, mas é importante manter boas práticas nos comentários também.
Péssimos comentários podem atrapalhar o entendimento do código, “sujar” o código e até confundir a manutenção do código.
Particularmente, eu não sou adepto a codificação com comentários, prefiro um código mais limpo e de fácil entendimento sem comentários.
Mas existem empresas que exigem que os códigos sejam bem documentados com comentários nos códigos.
Como o compilador não interpreta os comentários, é obrigação do desenvolvedor escrever comentários bem escritos.
Acesse o tutorial completo em: https://nakatech.herokuapp.com/article/2021/comment.html.