| Clube
VB - Documentando
o seu código
Aula
55
Em
sistemas comerciais complexos, temos uma infinidade de linhas de
código e, todo sistema requermanutenção. Com
o passar do tempo você poderá esquecer de alguns detalhes
ou "para que serve" um determinado trecho de código.
Assim sendo, a documentação do código é
muito importante para a manutenção do sistema, bem
como para facilitar o estudo das fontes por parte de uma equipe
de profissionais.
Os
comentários de código são empregados em três
objetivos distintos:
- Especificar
a finalidade de uma linha de comando do programa;
- Especificar
a finalidade de um procedimento completo do programa;
- Especificar
o objetivo de um determinado módulo do aplicativo.
Documentar
o código não é uma prática saudável
apenas para um aplicativo VB, mas em qualquer linguagem de programação/ambiente
de desenvolvimento.
Para
inserir uma linha de documentário em seu aplicativo, em qualquer
um dos níveis informados, você deverá usar o
símbolo ao lado ( ' ). Observe abaixo um exemplo de sequência
de linhas de comentários:
Private
Sub Command1_Click()
arquivo = List1.List(List1.ListIndex)
'na linha acima estamos armazenando o conteúdo
selecionado na caixa de listagem List1
'na variável arquivo
Image1.Picture
= LoadPicture(arquivo)
'na linha acima estamos informando que o componente
que irá receber a imagem deverá
'carrega-la no disco através de um nome identico ao da variável
arquivo.
End Sub
No
exemplo acima utilizamos o primeiro modo de documentar um programa,
ou seja, linha a linha. Este método não é empregado
em todo o sistema, pois em um aplicativo comercial, teremos milhares
de linhas de programas e, deveremos empregar este método
apenas em comandos mais complexos ou que possuam uma finalidade
especial no contexto do programa.
No
próximo módulo de aula iremos estudar sobre a documentação
de um determinado trecho de programa.
Voltar
Principal
| Cursos Gratuitos
| Cursos Diversos
| Dicas
| Promoções
| Mapa do
Site | QUIZ
|
|
Classificados | Central
Currículo | Fórum
| Fale Conosco |