RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Galera.. mudando um pouco o assunto da trhead. Eu gostaria da opinião de voces; sobre este caso de documentar o codigo fonte.. Digo... Porque do Sim...ou Porque do Não? Sempre tive em mente que se eu documentar o codigo fonte, poderia, digamos gerar por exemplo até uma sequencia ou uma lógica para os processos do sistema.. Pelo que vejo, pela quantidade de programdores que conheco..a qtd que fazem a documentação e em especial junto ao codigo fonte é quase 0so por curiosidade quem daqui da lista faz ...esta documentação? E porque? Atenc Elazar -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 08:05 Para: delphi-br@yahoogrupos.com.br Assunto: Re: [delphi-br] Re: Documentação de Código Fonte no Delphi 7 mrbar2000 wrote: gostei de como o fpdoc trabalha, tambem nao gosto muito desta coisa de comentar o código fonte nao! onde baixar? procurei e nao achei fpdoc é parte da instalação do Free Pascal ou do Lazarus. -- João Morais ___ Yahoo! Mail - Sempre a melhor opção para você! Experimente já e veja as novidades. http://br.yahoo.com/mailbeta/tudonovo/
RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Eu não teria justificativas pra dizer porque não. Teria algumas para dizer porque sim: - Documentar o fonte lhe ajuda muito numa manutenção futura. Imagine um projeto que tem mais de um ano que foi concluido e você nunca mais mexeu nele? - Documentar o fonte ajuda muito a rastrear uma rotina no meio de infinitas em um sistema muito grande. Imagine um sistema que tenha algo como 80 units e 40 janelas. Sem documentar fonte, você gastaria quanto tempo aproximadamente para achar o que estaria procurando alí? - Documentar o fonte ajuda a outros programadores, de uma mesma corporação, a dar manutenção em um sistema caso naquele momento você esteja indisponível para fazê-lo Dentre inúmeros motivos, eu citei apenas três. []s Walter Alves Chagas Junior Belo Horizonte - MG - Brazil [EMAIL PROTECTED] http://www.geocities.com/SiliconValley/Bay/1058 MSN: [EMAIL PROTECTED] --- Em delphi-br@yahoogrupos.com.br, Elazar Dornelles Ceza [EMAIL PROTECTED] escreveu Galera.. mudando um pouco o assunto da trhead. Eu gostaria da opinião de voces; sobre este caso de documentar o codigo fonte.. Digo... Porque do Sim...ou Porque do Não? Sempre tive em mente que se eu documentar o codigo fonte, poderia, digamos gerar por exemplo até uma sequencia ou uma lógica para os processos do sistema.. Pelo que vejo, pela quantidade de programdores que conheco..a qtd que fazem a documentação e em especial junto ao codigo fonte é quase 0so por curiosidade quem daqui da lista faz ...esta documentação? E porque? Atenc Elazar -Mensagem original- De: delphi-br@yahoogrupos.com.br [mailto:delphi- [EMAIL PROTECTED] Em nome de Joao Morais Enviada em: sexta-feira, 15 de dezembro de 2006 08:05 Para: delphi-br@yahoogrupos.com.br Assunto: Re: [delphi-br] Re: Documentação de Código Fonte no Delphi 7 mrbar2000 wrote: gostei de como o fpdoc trabalha, tambem nao gosto muito desta coisa de comentar o código fonte nao! onde baixar? procurei e nao achei fpdoc é parte da instalação do Free Pascal ou do Lazarus. -- João Morais ___ Yahoo! Mail - Sempre a melhor opção para você! Experimente já e veja as novidades. http://br.yahoo.com/mailbeta/tudonovo/
Re: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Elazar Dornelles Ceza wrote: Galera.. mudando um pouco o assunto da trhead. Eu gostaria da opinião de voces; sobre este caso de documentar o codigo fonte.. Digo... Porque do Sim...ou Porque do Não? Sempre tive em mente que se eu documentar o codigo fonte, poderia, digamos gerar por exemplo até uma sequencia ou uma lógica para os processos do sistema.. Pelo que vejo, pela quantidade de programdores que conheco..a qtd que fazem a documentação e em especial junto ao codigo fonte é quase 0so por curiosidade quem daqui da lista faz ...esta documentação? E porque? Em minha humilde opinião, código é pra ter duas coisas: - código; - comentário relacionado diretamente à implementação. Quanto ao comentário, restringe-se apenas a TODOs, avisos para outros desenvolvedores, e outras coisas do gênero. Sintaxe, explicações da funcionalidade, bla bla bla ficam em outro arquivo. A IDE do Lazarus reconhece documentos feitos em fpdoc e apresentam, em outra janela, o comentário da classe que está sob o cursor. Não sei se versões top do Delphi possuem tal funcionalidade. -- João Morais
Re: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
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. Sds, Romario Elazar Dornelles Ceza escreveu: Galera.. mudando um pouco o assunto da trhead. Eu gostaria da opinião de voces; sobre este caso de documentar o codigo fonte.. Digo... Porque do Sim...ou Porque do Não? Sempre tive em mente que se eu documentar o codigo fonte, poderia, digamos gerar por exemplo até uma sequencia ou uma lógica para os processos do sistema.. Pelo que vejo, pela quantidade de programdores que conheco..a qtd que fazem a documentação e em especial junto ao codigo fonte é quase 0so por curiosidade quem daqui da lista faz ...esta documentação? E porque? Atenc Elazar ___ Yahoo! Mail - Sempre a melhor opção para você! Experimente já e veja as novidades. http://br.yahoo.com/mailbeta/tudonovo/
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
RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
GRANDE ...Walter
Felipe e Romario
obrigado pelas respostas...um detalhe não é trhead é Thread..
Há com certeza quem diga...que programador que é programador (fera) não
precisa de comentários...mas já vi muito magros se perdendo no meio de
codigo fonte mal organizado..rsss
Particularmente eu procuro comentar as rotinas, normalmente faço deste
modo que vou mostrar mais abaixo quando estou criando alguma rotina,
principalmente em algumas regras de negocio que partem da ideia do que o
cliente pediu.
Podem me chamar de perfeccionista, tolo...o que for, mas não abro mão.
***Code;
Procedure TForm1.Button1Click(sender : Tobject);
Var
vCaminho : String; { Variavel para guardar o caminho e fazer as
verificacoes }
Begin
{ Procedimento que verifica se o caminho digitado pelo usuario é
válido
e cria o path caso o mesmo não existir }
{ Pega o valor do usuario }
vCaminho := Edit1.Text;
{ Verifica se o ultimo caracter do edit é diferente de uma barra }
if vCaminho[ Lenght( vCaminho)] '/' then begin
{ .Se diferente: }
{ Acrescento uma barra ao final }
vCaminho := '/';
{ Ajusta ao valor do usuário o caminho corrigido }
Edit1.Text := vCaminho;
end;
{}
{ Verifico se o caminho existe }
if DirectoryExists( vCaminho) then begin
{ .Se existir }
{ Informo ao usuario que existe }
ShowMessage('Caminho Existe');
end else begin
{ .Se não existir }
{ Crio o caminho }
ForceDirectory(vCaminho);
{ Informo ao usuário que o caminho foi criado }
ShowMessage('Caminho foi criado');
end;
{}
End;
Eu fiz um pequeno programa que quando executado na unit que contenha os
comentários na forma assim ele cria um txt com como abaixo,
basicamente...ele estrai as linhas que tem comentários, ( bem simples,
basicamente utilizando um Stringlist o pos e o copy...)
***
Unit Teste
- Procedimento Button1Click;
** Procedimento que verifica se o caminho digitado pelo usuario é válido
e cria o path caso o mesmo não existir
Pega o valor do usuario
Verifica se o ultimo caracter do edit é diferente de uma barra }
.Se diferente:
Acrescento uma barra ao final
Ajusta ao valor do usuário o caminho corrigido
Verifico se o caminho existe
.Se existir
Informo ao usuario que existe
.Se não existir }
Crio o caminho }
Informo ao usuário que o caminho foi criado }
**
Atenc.
Elazar
-Mensagem original-
De: delphi-br@yahoogrupos.com.br [mailto:[EMAIL PROTECTED]
Em nome de Elazar Dornelles Ceza Enviada em: sexta-feira, 15 de dezembro
de 2006 10:28
Para: delphi-br@yahoogrupos.com.br
Assunto: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Galera..
mudando um pouco o assunto da trhead.
Eu gostaria da opinião de voces; sobre este caso de documentar o codigo
fonte.. Digo... Porque do Sim...ou Porque do Não?
Sempre tive em mente que se eu documentar o codigo fonte, poderia,
digamos gerar por exemplo até uma sequencia ou uma lógica para os
processos do sistema..
Pelo que vejo, pela quantidade de programdores que conheco..a qtd que
fazem a documentação e em especial junto ao codigo fonte é quase 0so
por curiosidade quem daqui da lista faz ...esta documentação? E porque?
Atenc
Elazar
-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 08:05
Para: delphi-br@yahoogrupos.com.br
Assunto: Re: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
mrbar2000 wrote:
gostei de como o fpdoc trabalha, tambem nao gosto muito desta coisa de
comentar o código fonte nao!
onde baixar? procurei e nao achei
fpdoc é parte da instalação do Free Pascal ou do Lazarus.
--
João Morais
___
Yahoo! Mail - Sempre a melhor opção para você!
Experimente já e veja as novidades.
http://br.yahoo.com/mailbeta/tudonovo/
___
Yahoo! Mail - Sempre a melhor opção para você!
Experimente já e veja as novidades.
http://br.yahoo.com/mailbeta/tudonovo/
RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Elazar,
Tudo nesse mundo tem limites. Comentar ajuda? Claro que ajuda, mas
comentar demais vai é atrapalhar. A regra básica para comentarios
deve seguir algumas premissas:
1) Cabeçalho da Unit deve conter dados e dependencias dela.
2) Procedimentos e funções que não pertençam a classe. Somente a
descrição do que fazem e pra que servem.
3) Rotinas complexas e vitais no programa (as que tratam diretamente
ds regras de negócios.
4) Rotinas problemáticas ou as que lhe deram trabalho pra ajustá-las.
Qualquer coisa fora disso aí, não agrega e ainda pode é atrapalhar a
interpretação lógica do código. Comentar variável ou linha a linha,
bobagem. Você vai perder muito tempo com isso pois, em tese, estarias
codificando duas vezes.
[]s
Walter Alves Chagas Junior
Belo Horizonte - MG - Brazil
[EMAIL PROTECTED]
http://www.geocities.com/SiliconValley/Bay/1058
MSN: [EMAIL PROTECTED]
--- Em delphi-br@yahoogrupos.com.br, Elazar Dornelles Ceza
[EMAIL PROTECTED] escreveu
GRANDE ...Walter
Felipe e Romario
obrigado pelas respostas...um detalhe não é trhead é Thread..
Há com certeza quem diga...que programador que é programador (fera)
não
precisa de comentários...mas já vi muito magros se perdendo no meio
de
codigo fonte mal organizado..rsss
Particularmente eu procuro comentar as rotinas, normalmente faço
deste
modo que vou mostrar mais abaixo quando estou criando alguma rotina,
principalmente em algumas regras de negocio que partem da ideia do
que o
cliente pediu.
Podem me chamar de perfeccionista, tolo...o que for, mas não abro
mão.
***Code;
Procedure TForm1.Button1Click(sender : Tobject);
Var
vCaminho : String; { Variavel para guardar o caminho e fazer as
verificacoes }
Begin
{ Procedimento que verifica se o caminho digitado pelo usuario é
válido
e cria o path caso o mesmo não existir }
{ Pega o valor do usuario }
vCaminho := Edit1.Text;
{ Verifica se o ultimo caracter do edit é diferente de uma barra }
if vCaminho[ Lenght( vCaminho)] '/' then begin
{ .Se diferente: }
{ Acrescento uma barra ao final }
vCaminho := '/';
{ Ajusta ao valor do usuário o caminho corrigido }
Edit1.Text := vCaminho;
end;
{}
{ Verifico se o caminho existe }
if DirectoryExists( vCaminho) then begin
{ .Se existir }
{ Informo ao usuario que existe }
ShowMessage('Caminho Existe');
end else begin
{ .Se não existir }
{ Crio o caminho }
ForceDirectory(vCaminho);
{ Informo ao usuário que o caminho foi criado }
ShowMessage('Caminho foi criado');
end;
{}
End;
Eu fiz um pequeno programa que quando executado na unit que
contenha os
comentários na forma assim ele cria um txt com como abaixo,
basicamente...ele estrai as linhas que tem comentários, ( bem
simples,
basicamente utilizando um Stringlist o pos e o copy...)
***
Unit Teste
- Procedimento Button1Click;
** Procedimento que verifica se o caminho digitado pelo usuario é
válido
e cria o path caso o mesmo não existir
Pega o valor do usuario
Verifica se o ultimo caracter do edit é diferente de uma barra }
.Se diferente:
Acrescento uma barra ao final
Ajusta ao valor do usuário o caminho corrigido
Verifico se o caminho existe
.Se existir
Informo ao usuario que existe
.Se não existir }
Crio o caminho }
Informo ao usuário que o caminho foi criado }
**
Atenc.
Elazar
-Mensagem original-
De: delphi-br@yahoogrupos.com.br [mailto:delphi-
[EMAIL PROTECTED]
Em nome de Elazar Dornelles Ceza Enviada em: sexta-feira, 15 de
dezembro
de 2006 10:28
Para: delphi-br@yahoogrupos.com.br
Assunto: RES: [delphi-br] Re: Documentação de Código Fonte no
Delphi 7
Galera..
mudando um pouco o assunto da trhead.
Eu gostaria da opinião de voces; sobre este caso de documentar o
codigo
fonte.. Digo... Porque do Sim...ou Porque do Não?
Sempre tive em mente que se eu documentar o codigo fonte, poderia,
digamos gerar por exemplo até uma sequencia ou uma lógica para os
processos do sistema..
Pelo que vejo, pela quantidade de programdores que conheco..a qtd
que
fazem a documentação e em especial junto ao codigo fonte é quase
0so
por curiosidade quem daqui da lista faz ...esta documentação? E
porque?
Atenc
Elazar
-Mensagem original-
De: delphi-br@yahoogrupos.com.br [mailto:delphi-
[EMAIL PROTECTED]
Em nome de Joao Morais
Enviada em: sexta-feira, 15 de dezembro de 2006 08:05
Para: delphi-br@yahoogrupos.com.br
Assunto: Re: [delphi-br] Re: Documentação de Código Fonte no Delphi
7
mrbar2000 wrote:
gostei de como o fpdoc trabalha, tambem nao gosto muito desta
coisa de
comentar o código fonte nao!
onde baixar? procurei e nao achei
Re: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Walter Chagas (Yahoo) wrote:
Elazar,
Tudo nesse mundo tem limites. Comentar ajuda? Claro que ajuda, mas
comentar demais vai é atrapalhar. A regra básica para comentarios
deve seguir algumas premissas:
1) Cabeçalho da Unit deve conter dados e dependencias dela.
2) Procedimentos e funções que não pertençam a classe. Somente a
descrição do que fazem e pra que servem.
3) Rotinas complexas e vitais no programa (as que tratam diretamente
ds regras de negócios.
4) Rotinas problemáticas ou as que lhe deram trabalho pra ajustá-las.
4.1) Aviso sobre rotinas ou estruturas aparentemente inofensivas mas que
não devem ser tocadas por causa de algum acesso de baixo nível em algum
ponto do sistema. Sempre tem alguém querendo 'otimizar' alguma coisa.
Qualquer coisa fora disso aí, não agrega e ainda pode é atrapalhar a
interpretação lógica do código. Comentar variável ou linha a linha,
bobagem. Você vai perder muito tempo com isso pois, em tese, estarias
codificando duas vezes.
Bingo. Por isso sou fã do fpdoc.
Walter Alves Chagas Junior
Belo Horizonte - MG - Brazil
[EMAIL PROTECTED]
http://www.geocities.com/SiliconValley/Bay/1058
MSN: [EMAIL PROTECTED]
--
João Morais
--- Em delphi-br@yahoogrupos.com.br, Elazar Dornelles Ceza
[EMAIL PROTECTED] escreveu
GRANDE ...Walter
Felipe e Romario
obrigado pelas respostas...um detalhe não é trhead é Thread..
Há com certeza quem diga...que programador que é programador (fera)
não
precisa de comentários...mas já vi muito magros se perdendo no meio
de
codigo fonte mal organizado..rsss
Particularmente eu procuro comentar as rotinas, normalmente faço
deste
modo que vou mostrar mais abaixo quando estou criando alguma rotina,
principalmente em algumas regras de negocio que partem da ideia do
que o
cliente pediu.
Podem me chamar de perfeccionista, tolo...o que for, mas não abro
mão.
***Code;
Procedure TForm1.Button1Click(sender : Tobject);
Var
vCaminho : String; { Variavel para guardar o caminho e fazer as
verificacoes }
Begin
{ Procedimento que verifica se o caminho digitado pelo usuario é
válido
e cria o path caso o mesmo não existir }
{ Pega o valor do usuario }
vCaminho := Edit1.Text;
{ Verifica se o ultimo caracter do edit é diferente de uma barra }
if vCaminho[ Lenght( vCaminho)] '/' then begin
{ .Se diferente: }
{ Acrescento uma barra ao final }
vCaminho := '/';
{ Ajusta ao valor do usuário o caminho corrigido }
Edit1.Text := vCaminho;
end;
{}
{ Verifico se o caminho existe }
if DirectoryExists( vCaminho) then begin
{ .Se existir }
{ Informo ao usuario que existe }
ShowMessage('Caminho Existe');
end else begin
{ .Se não existir }
{ Crio o caminho }
ForceDirectory(vCaminho);
{ Informo ao usuário que o caminho foi criado }
ShowMessage('Caminho foi criado');
end;
{}
End;
Eu fiz um pequeno programa que quando executado na unit que
contenha os
comentários na forma assim ele cria um txt com como abaixo,
basicamente...ele estrai as linhas que tem comentários, ( bem
simples,
basicamente utilizando um Stringlist o pos e o copy...)
***
Unit Teste
- Procedimento Button1Click;
** Procedimento que verifica se o caminho digitado pelo usuario é
válido
e cria o path caso o mesmo não existir
Pega o valor do usuario
Verifica se o ultimo caracter do edit é diferente de uma barra }
.Se diferente:
Acrescento uma barra ao final
Ajusta ao valor do usuário o caminho corrigido
Verifico se o caminho existe
.Se existir
Informo ao usuario que existe
.Se não existir }
Crio o caminho }
Informo ao usuário que o caminho foi criado }
**
Atenc.
Elazar
-Mensagem original-
De: delphi-br@yahoogrupos.com.br [mailto:delphi-
[EMAIL PROTECTED]
Em nome de Elazar Dornelles Ceza Enviada em: sexta-feira, 15 de
dezembro
de 2006 10:28
Para: delphi-br@yahoogrupos.com.br
Assunto: RES: [delphi-br] Re: Documentação de Código Fonte no
Delphi 7
Galera..
mudando um pouco o assunto da trhead.
Eu gostaria da opinião de voces; sobre este caso de documentar o
codigo
fonte.. Digo... Porque do Sim...ou Porque do Não?
Sempre tive em mente que se eu documentar o codigo fonte, poderia,
digamos gerar por exemplo até uma sequencia ou uma lógica para os
processos do sistema..
Pelo que vejo, pela quantidade de programdores que conheco..a qtd
que
fazem a documentação e em especial junto ao codigo fonte é quase
0so
por curiosidade quem daqui da lista faz ...esta documentação? E
porque?
Atenc
Elazar
-Mensagem original-
De: delphi-br@yahoogrupos.com.br [mailto:delphi-
[EMAIL PROTECTED]
Em nome de Joao Morais
Enviada em: sexta-feira, 15 de
Re: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
Bem, essa é a sua opinião. Eu, particularmente, não partilho dela. Eu comento linha à linha. Nunca me atrapalhei com isso e, pelo visto, nunca atrapalhou ninguém. Pelos elogios que recebi, eles só ajudaram. Não acho que seja bobagem e nem que vai perder muito tempo. Pelo contrário, explicando isso para meus alunos eu fiz com que eles fixassem a lógica do sistema através dos comentários que eles inseriram. E isso não serve só para alunos, serve para nós também. Sds, Romario Walter Chagas (Yahoo) escreveu: Elazar, Tudo nesse mundo tem limites. Comentar ajuda? Claro que ajuda, mas comentar demais vai é atrapalhar. A regra básica para comentarios deve seguir algumas premissas: 1) Cabeçalho da Unit deve conter dados e dependencias dela. 2) Procedimentos e funções que não pertençam a classe. Somente a descrição do que fazem e pra que servem. 3) Rotinas complexas e vitais no programa (as que tratam diretamente ds regras de negócios. 4) Rotinas problemáticas ou as que lhe deram trabalho pra ajustá-las. Qualquer coisa fora disso aí, não agrega e ainda pode é atrapalhar a interpretação lógica do código. Comentar variável ou linha a linha, bobagem. Você vai perder muito tempo com isso pois, em tese, estarias codificando duas vezes. []s Walter Alves Chagas Junior ___ Yahoo! Mail - Sempre a melhor opção para você! Experimente já e veja as novidades. http://br.yahoo.com/mailbeta/tudonovo/
Re: RES: RES: [delphi-br] Re: Documentação de Código Fonte no Delphi 7
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
