Re: [delphi-br] Cometarios dentro dos fontes
> eu não faço pelo fato de que, eu estaria perdendo muito tempo de > desenvolvimento > para colocar comentario, sendo que o proprio tipo da informação ja dispensa o > comentario. Eu também vou por essa linha de raciocínio. Seu código tem que ser legível o suficiente para quem ler, entender o que está acontecendo ali, inclusive nomes de variáveis. Tem até aquela frase que diz que "bons programadores escrevem código que as pessoas possam entender". Jackson Gomes Tools&Comps - Controle de Usuários para Desenvolvedores Borland/CodeGear Web Site: http://www.toolsandcomps.com Nosso Fórum: http://groups.yahoo.com/group/toolsandcomps e-mail: [EMAIL PROTECTED] Fone: 27 3389 1138 - 8811 0324 Devhost - Webhost para desenvolvedores Borland http://www.devhost.com.br [EMAIL PROTECTED]
Re: [delphi-br] Cometarios dentro dos fontes
referente a comentarios tipo: // Funcao: Soma // Parametros: a, b: Inteiro // Retorno: Inteiro // Descrição: Somar dois valores // Autor: Beltrano da Silva // Data: 01/02/2008 // Ultima atualização: - // Modificacoes: - function Soma(a, b: Integer): Integer; begin Result := a + b; end; eu não faço pelo fato de que, eu estaria perdendo muito tempo de desenvolvimento para colocar comentario, sendo que o proprio tipo da informação ja dispensa o comentario. se eu em uma procedure coloco as VARs, onde tenho vars do tipo: Integer, String, EXEMPLO: VAR wsNome : String Begin então qual o motivo de eu colocar uma linha de comentario falando que a variavel é do tipo Caracter, sendo que a propria definição de tipo da variavel ja esta falando o que ela é. por isso que eu não coloco esse tipo de comentario pois perderia tempo atoa. Porque eu vou colocar um comentario descrito: Função Soma, sendo que a definição me diz: Function Soma? Causa sem efeito e desperdicio de tempo. O unico comentario que eu coloco é para dar uma explicação sobre determinado bloco do programa. Jhosef Marks <[EMAIL PROTECTED]> escreveu: Pessoal, aki onde trabalho estamos querendo refazer o sistema q existe hoje, pois foi muito mal desenvolvido, sem padronização, documentação e ateh falta de comentarios dentro do fonte... Discutimos que teriamos a documentação para o usuário (Help) e uma documentação tecnica para os desenvolvedores, criamos um arquivo de boas práticas e agora estamos discutindo critérios de comentários... E ai como vc's comentam seus códigos??? Comenta os blocos de códigos de acordo com a funcionalidade function Soma(a, b: Integer): Integer; begin Result := a + b; //Soma a e b e devolve o resultado end; ou apenas coloca uma espécie de cabeçario para cada função ou procedure que eh criado // Funcao: Soma // Parametros: a, b: Inteiro // Retorno: Inteiro // Descrição: Somar dois valores // Autor: Beltrano da Silva // Data: 01/02/2008 // Ultima atualização: - // Modificacoes: - function Soma(a, b: Integer): Integer; begin Result := a + b; end; -- Jhosef Marks de Carvalho Delphi Developer http://groups.google.com/group/soumaisdelphi [As partes desta mensagem que não continham texto foram removidas] - Abra sua conta no Yahoo! Mail, o único sem limite de espaço para armazenamento! [As partes desta mensagem que não continham texto foram removidas]
Re: [delphi-br] Cometarios dentro dos fontes
Prefiro cabeçalho Luiz Escobar - Analista/Desenvolvedor: WEB - HTML/JavaScript/PHP/MySQL WINDOWS - Delphi/ASSEMBLY/MySQL/xBase SERVIDORES - CNA IntraNetWare4.11, LINUX-(RedHat9/Suse10.2), Windows 2K/XP HARBOUR Borland C++ 5.5.1 (32 bit) Harbour Devel build 1.1-1 Intl. Harbour MiniGUI 1.4 Extended Edition (Build 47) - 2007.12.21 - From: Jhosef Marks Sent: Friday, February 01, 2008 4:33 PM To: [EMAIL PROTECTED] Subject: [delphi-br] Cometarios dentro dos fontes Pessoal, aki onde trabalho estamos querendo refazer o sistema q existe hoje, pois foi muito mal desenvolvido, sem padronização, documentação e ateh falta de comentarios dentro do fonte... Discutimos que teriamos a documentação para o usuário (Help) e uma documentação tecnica para os desenvolvedores, criamos um arquivo de boas práticas e agora estamos discutindo critérios de comentários... E ai como vc's comentam seus códigos??? Comenta os blocos de códigos de acordo com a funcionalidade function Soma(a, b: Integer): Integer; begin Result := a + b; //Soma a e b e devolve o resultado end; ou apenas coloca uma espécie de cabeçario para cada função ou procedure que eh criado // Funcao: Soma // Parametros: a, b: Inteiro // Retorno: Inteiro // Descrição: Somar dois valores // Autor: Beltrano da Silva // Data: 01/02/2008 // Ultima atualização: - // Modificacoes: - function Soma(a, b: Integer): Integer; begin Result := a + b; end; -- Jhosef Marks de Carvalho Delphi Developer http://groups.google.com/group/soumaisdelphi [As partes desta mensagem que não continham texto foram removidas] [As partes desta mensagem que não continham texto foram removidas]
Re: [delphi-br] Cometarios dentro dos fontes
Salve... Ano passado passei pelo mesmo processo criar uma documentação de boas praticas e padronização de codigo e nos baseamos nestes links http://dn.codegear.com/article/10280#1.0 http://www.delphi.eti.br/ver_artigo.php?id=123 espero ter ajudado Marcos Bernardo Em 01/02/08, Jhosef Marks <[EMAIL PROTECTED]> escreveu: > > Pessoal, aki onde trabalho estamos querendo refazer o sistema q existe > hoje, > pois foi muito mal desenvolvido, sem padronização, documentação e ateh > falta > de comentarios dentro do fonte... > > Discutimos que teriamos a documentação para o usuário (Help) e uma > documentação tecnica para os desenvolvedores, criamos um arquivo de boas > práticas e agora estamos discutindo critérios de comentários... > > E ai como vc's comentam seus códigos??? > > Comenta os blocos de códigos de acordo com a funcionalidade > > function Soma(a, b: Integer): Integer; > begin > Result := a + b; //Soma a e b e devolve o resultado > end; > > ou apenas coloca uma espécie de cabeçario para cada função ou procedure > que > eh criado > > // Funcao: Soma > // Parametros: a, b: Inteiro > // Retorno: Inteiro > // Descrição: Somar dois valores > // Autor: Beltrano da Silva > // Data: 01/02/2008 > // Ultima atualização: - > // Modificacoes: - > function Soma(a, b: Integer): Integer; > begin > Result := a + b; > end; > -- > Jhosef Marks de Carvalho > Delphi Developer > http://groups.google.com/group/soumaisdelphi > > [As partes desta mensagem que não continham texto foram removidas] > > > [As partes desta mensagem que não continham texto foram removidas]
