Romario (Listas) wrote: > Um dos meus professores me disse um dia que devemos comentar o código > imaginando que o maior de todos os leigos dará manutenção nessa > aplicação. Não dei ouvidos à ele. > > Um ano depois fui contratado para dar manutenção em um sistema > gigantesco e que não tinha NENHUM comentário no código. > > Passei um sufoco danado pelo prazo apertado e tive que trabalhar doze > horas diárias para efetuar as manutenções no tempo previsto. > > A partir daquele dia, comento cada linha de código dos meus sistemas. > > E digo mais: recebo muitos elogios de empresas e desenvolvedores por > comentar o código dessa forma.
Concordo em gênero, número e grau com os colegas Walter e Romário, todavia a documentação poderia estar em outro local ao invés dos fontes. Quem não conhece, lê a documentação. Quem já conhece vai ler apenas o código, que no final das contas é o que realmente interessa. -- João Morais
