Walter;;;
ja esperava por comentários do genero. em tese eu deveria por na msg..bem grande pra todo mundo entender.. "EXEMPLO" atente. "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 <-- assim fica facil mostrar pra ele a linha de raciocinio que o programa segue..(que originou da ideia ou regra que ele determinou e digamos que equivale ao item 3,4 da sua msg ) diria que assim vou criar uma "rotina na liguagem que o cliente entende".. E não, que em todo os casos eu vou usar como mencionei na msg anterior pois, concordo com voce plenamente, que não precisaria comentar um procedimento que simplesmente adiciona um / no final de uma string e cria um diretorio... Atenc. Elazar. -----Mensagem original----- De: delphi-br@yahoogrupos.com.br [mailto:[EMAIL PROTECTED] Em nome de Walter Chagas (Yahoo) Enviada em: sexta-feira, 15 de dezembro de 2006 14:07 Para: delphi-br@yahoogrupos.com.br Assunto: 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 0....so > 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/ > > > > > > > > _______________________________________________________ > 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/
