A linguagem de programação de computador Microsoft Visual Basic é popular nos círculos de programação há muitos anos. Os programadores o usam para todos os tipos de projetos. Variantes dessa linguagem de programação são usadas para páginas da web, e outros tipos de programas Visual Basic são usados para muitos dos aplicativos do Windows que usamos todos os dias. Um dos elementos essenciais do Visual Basic é a capacidade de incluir comentários, que são notas incorporadas ao código que não têm uma finalidade de código funcional. Visual Basic usa protocolo específico para distingui-los do código. Adicionar comentários é extremamente importante na maioria dos projetos para ajudar os visualizadores de código humanos a ler os módulos de código corretamente. Se você precisar adicionar comentários ao Visual Basic, aqui estão algumas das etapas fundamentais para garantir que você faça isso corretamente.
Passos
Etapa 1. Determine qual tipo de comentário você deseja adicionar
Os programadores têm vários propósitos principais diferentes para comentários que determinam o formato e estilo exatos do que será incluído no comentário.
- Considere os comentários do módulo de código. Os comentários do módulo são comentários de nível superior que geralmente descrevem os objetivos gerais do módulo de código, bem como outras informações como direitos autorais, autoria e muito mais.
- Avalie a necessidade de comentários sobre o procedimento. Vários procedimentos de código funcional também devem ser comentados. Os comentários do procedimento estão relacionados às funções específicas do código e ajudam a alertar outros programadores sobre os resultados exatos de um procedimento de acordo com a forma como ele foi escrito.
Etapa 2. Escolha categorias detalhadas de uso para seus comentários de código
Alguns tipos de comentários, como comentários de procedimento, também vêm em formas diferentes. Compreenda esses diferentes usos para adicionar os tipos certos de comentários ao seu programa.
- Avalie o uso de comentários de propósito para procedimentos. Descrevem o que o procedimento faz.
- Considere o uso de comentários de valor de retorno de função. Isso ajudará outras pessoas a entender quais valores são retornados pelo procedimento.
- Inclua comentários condicionais. Os comentários condicionais podem descrever possíveis condições de erro e tratamento de erros, bem como condições que devem ser atendidas para que o código funcione corretamente.
Etapa 3. Escolha um formato para comentários
Há também o problema de como você adicionará comentários a linhas específicas de código.
- Utilize comentários canhotos. Esses comentários começam no lado esquerdo da tela e continuam ao longo de uma linha. Normalmente, o codificador precisa encerrar arbitrariamente o comentário próximo ao lado direito da tela, descer para uma nova linha e continuar o comentário.
- Use comentários in-line. Os comentários em linha têm um apóstrofo diretamente após um trecho de código e são colocados na mesma linha.
Etapa 4. Use um apóstrofo para marcar o início de seus comentários
Esta é a etapa chave para realmente escrever comentários no código. O apóstrofo é o protocolo de texto específico que o compilador Visual Basic reconhece para comentários. Sem isso, o computador tentará ler os comentários como código.
