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
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
Particularmente uso comentário da seguinte forma:
//Soma a e b e devolve o resultado
function Soma(a, b: Integer): Integer;
begin
Result := a + b;
end;
//Soma fim.
fica mais claro para sabe onde começa e termina o procedimento,
uso muito isso em java.
vlw
Abra sua conta no Yahoo!
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
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
: [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
6 matches
Mail list logo
