Fórum de discussão

Oi Edgar,

Nesse EP, as funções já estão comentadas. Até que ponto devo adicionar algum comentário de minha autoria?

Comentar um programa não é uma tarefa fácil. Sobre comentários, sugiro que vocês leiam a página

http://www.ime.usp.br/~pf/algoritmos/aulas/docu.html

de Paulo Feofiloff. Entre outras coisas, lá está escrito que:

"... Há quem diga que documentar um programa é o mesmo que escrever muitos comentários de mistura com o código. Totalmente errado! Uma boa documentação não suja o código com comentários. Uma boa documentação limita-se a

explicar o que cada função do programa faz.

Em geral, uma boa documentação não perde tempo tentando explicar como uma função faz o que faz, porque o leitor interessado nesse assunto é capaz de ler o código. ..."

O funcionamento das funções dá para ser compreendido simplesmente lendo o código... e o que a função faz já está escrito..

Nesse caso, creio que e não há necessidade de comentários extras.