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.
Configurando o IDE
Primeiro teremos que habilitar nosso IDE pra exibir o painel de ajuda em tempo de desenvolvimento, para isso, acesse o menu Tools>Options>Editor Options>Code Insight. No ComboBox Source file type selecione a opção Pascal e logo em seguida marque a opção Tooltip Help Insight caso não esteja e clique em Ok (Figura 1).
...
