Codigo Limpo

CODIGO LIMPO – COMENTÁRIOS
Nada pode ser tão útil quanto um comentário bem colocado. Nada consegue amontoar um módulo mais do que comentários dogmáticos e supérfluos. Nada pode ser tão prejudical quanto um velho comentário mal feito que dissemina mentiras e informações incorretas.
Comentários não são como a Lista de Schindler. Não são o “bom puro”. De fato, eles são, no máximo, um mal necessário. Se nossas linguagens de programação fossem expressivas o suficiente ou se tivéssemos o talento para manipular com destreza tais linguagens de modo a expressar nossa intenção, não precisaríamos de muitos comentários, quiça nenhum.
O uso adequado de comentários é compensar nosso fracasso em nos expressar no código.
Observe que usei a palavra fracasso. E é isso que eu quis dizer. Comentários são sempre fracassos.
Devemos usá-los porque nem sempre encontramos uma forma de nos expressar sem eles, mas seu uso não é motivo para comemoração.
Códigos mudam e evoluem. Movem-se blocos para lá e para cá, que se bifurcam e se reproduzem e se unem novamente, formando monstros gigantes. Infelizmente, os comentários nem sempre os seguem – nem sempre é possível. E, muito frequentemente, os comentários ficam longe do código o qual descrevem e se tornam dizeres órfãos com uma exatidão cada vez menor.
Comentários imprecisos são muito piores do que nenhum. Eles enganam e iludem; deixam expectativas que jamais serão cumpridas; citam regras antigas que não precisariam mais, ou não deveriam, ser seguidas.
Só se pode encontrar a verdade em um lugar: no código. Só ele pode realmente lhe dizer o que ele faz. Ele é a única fonte de informações verdadeiramente precisas. Entretanto, embora às vezes comentários sejam necessários, gastaríamos energia considerável para minimizá-los.
1. Comentários compensam um código ruim
Uma das motivações mais comuns para criar comentários é um código ruim. Construímos um módulo e sabemos que está confuso e desorganizado. Estamos cientes da