Projeto Aprenda em Casa - Cursos gratuitos

Clube VB - Documentando o seu código - Parte II

Aula 56

Em sistemas comerciais, teremos diversos procedimentos e módulos que irão compor o sistema e, é importante documentar cada módulo ou procedimento, fazendo com que os demais desenvolvedores envolvidos no projeto, tenham uma exata noção do objetivo ou da função daquele procedimento ou módulo. Este tipo de comentário poderá ajudar também que outros programadores da equipe, possam reutilizar o módulo ou procedimento, sabendo a função do mesmo, em outros projetos da própria empresa. Abaixo estamos sugerindo um padrão para comentar o inicio de um módulo ou de um procedimento:

'Nome_arquivo: controle_acesso.cls
'Autor: Paulo Matuszewski
'Data: 09/11/2004
'Descrição: este módulo tem por objetivo realizar o controle de acesso aos usuários cadastrados e
'.................. devidamente autorizados a utilizarem o sistema. Utiliza o banco de dados Empresa.MDB e a tabela
'.................. usuarios.
'Última alteração da rotina: 05/06/2004

Observe que incluindo um comentário completo no inicio de um módulo ou procedimento/rotina, você estará facilitando a vida de colegas de trabalho assim como a sua, pois você poderá ficar meses sem a necessidade de realizar alterações no sistema e, quando o fizer, conseguirá interpretar com facilidade a função das mesmas.

Não existe um padrão definido para a inclusão dos mesmos, o trecho acima é apenas uma sugestão e, poderá ser livremente adaptado para as suas necessidades.

No próximo módulo de aula iremos estudar sobre as convenções de nomeação.

Voltar