Artigo Clube Delphi Magazine 98 - Saiba como documentar seu código fonte

Artigo publicado pela Clube Delphi Magazine edição 98.

Esse artigo faz parte da revista Clube Delphi Magazine edição 98. Clique aqui para ler todos os artigos desta edição

Clique aqui para ler essa revista em PDF.

Boas Práticas - Novidades

Saiba como documentar seu código-fonte

Documentando propriedades e métodos com o RAD Studio 2007

 

Neste artigo veremos

·Como documentar corretamente o código fonte;

·Criando documentação.

Qual a finalidade

·A documentação é essencial para que outros programadores possam dar manutenção no seu código.

Quais situações utilizam esses recursos?

·Em todos os projetos se faz necessário uma boa documentação para que possamos melhorar ainda mais a codificação do aplicativo.

 

Resumo DevMan

Veremos neste artigo como documentar nosso código-fonte de forma que seja possível vermos todas as informações e exemplos necessários para determinadas funções, assim fica mais fácil compreendermos nossos sistemas.

 

Neste artigo veremos como documentar nosso código fonte utilizando o RAD Studio 2007. É sabido que a cada nova versão, nosso Delphi vem com várias novidades e uma delas é o Tooltip Help Insight, presente desde o Delphi 8. O recurso permite, em tempo de desenvolvimento, obter informações sobre um determinado método ou propriedade no ato da codificação. Apenas na versão 2007 é que nós desenvolvedores podemos documentar cada propriedade ou método de nosso projeto. Na prática, veremos como documentar e fazer uso desse recurso para nos auxiliar no dia-a-dia." [...] continue lendo...

Artigos relacionados