Elazar Dornelles Ceza wrote: > Até posso concordar. > > Mas.. > > Mas a Ide do delphi até a versão 7 pelo que "eu sei" não possui tal > recurso, e ficar abrindo aquirvos pra ler..estando no meio de uma > codificação pode se tornar meio complexo...principalmente pra quem esta > entrando no ritmo de um projeto, ainda mais se já em andamento a algum > tempo.
Acontece que você não usa a documentação 'debaixo do braço' quando vai codificar. Você a utiliza se você não conhece o código, e você só codifica se você conhecer o código. E se você conhece o código você não precisa de documentação. As vezes tudo o que o cara precisa é saber a sintaxe de tal coisa, e isso o próprio Code-Não-Lembro-o-Que (ctrl+click, ctrl+barra de espaço) do editor faz por você. > Se voce conhece algum plugin, que faça isto eu adoraria testar. Nope. > E. > > O único incoveniente gerado diretamente por ter arquivos separados para > a documentação é que toda vez que voce alterar o codigo fonte, teras que > abrir outro arquivo pra ajustar a documentação. Vai que um dia na pressa > voce troque algo e esqueça da documentação (vulgo: deixa pra depois), na > proxima vez..voce vai se entender, mas outra pessoa vai embananar-se > todo pra sacar o que aconteceu. O negócio é não ter pressa. > E estando os dois juntos, no momento que alterou um...automaticamente > esta alterando o outro. Insira um TODO dentro do código ;-) > Atenc. > Elazar -- João Morais > > -----Mensagem original----- > De: delphi-br@yahoogrupos.com.br [mailto:[EMAIL PROTECTED] > Em nome de Joao Morais > Enviada em: sexta-feira, 15 de dezembro de 2006 11:57 > Para: delphi-br@yahoogrupos.com.br > Assunto: Re: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi > 7 > > > 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 > >
