Comentários no código
À medida que você lê os exemplos de código, você encontra geralmente o símbolo de comentário (').Esse símbolo informa ao compilador Visual Basic que ele deve ignorar o texto ou o comentário que o segue.Os comentários são uma breve explicação e/ou anotações adicionadas ao código para o benefício de quem o ler.
É uma prática recomendável de programação iniciar todos os procedimentos com um breve comentário descrevendo as características do procedimento e sua funcionalidade (o que ele faz).Isso é um benefício para o programador e é vantajoso para qualquer pessoa que examine o código.Você deve separar os detalhes de implementação (como o procedimento faz isso) dos comentários que descrevem as características funcionais.Quando você incluir detalhes de implementação na descrição, lembre-se de atualizá-los quando você atualizar a função.
Comentários podem seguir uma instrução na mesma linha ou ocupar uma linha inteira.Ambos são ilustrados no código a seguir.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Se seu comentário exigir mais de uma linha, use o símbolo de comentário em cada linha, como o exemplo a seguir mostra.
' This comment is too long to fit on a single line, so we break
' it into two lines. Some comments might need three or more lines.
Diretrizes de Comentários
A tabela a seguir fornece diretrizes gerais para os tipos de comentários que podem preceder uma seção de código.Esses são sugestões; Visual Basic não impõe regras para adicionar comentários.Escreva o que funciona melhor, tanto para você quanto para qualquer outra pessoa que leia seu código.
Tipo de Comentário |
Descrição de Comentário |
|---|---|
Objetivo |
Descreve o que o procedimento faz (não como ele faz isso) |
Suposições |
Lista cada variável externa, controle, arquivo aberto, ou outro elemento acessado pelo procedimento |
Efeitos |
Listas cada afetados variável externos, controle, ou arquivo, e o efeito possui (somente se ele for Não óbvio) |
Entradas |
Especifica a finalidade do argumento |
Retornos |
Explica os valores retornados pelo procedimento |
Lembre-se os seguintes pontos:
Cada declaração de variável importante deve ser precedido por um comentário sobre o uso da variável sendo declarada.
Variáveis, controles e procedimentos devem ser chamados claramente suficiente de forma que os comentáriso sejam necessários somente para detalhes de implementação complexos.
Comentários não é podem seguir uma sequência de continuação de linha na mesma linha.
Você pode adicionar ou remover símbolos de comentário de um bloco de código, selecionando uma ou mais linhas de código e escolhendo Comment (.gif)
)e Uncommentt (botões .gif)
na barra de ferramentasEdit).
.gif "Observação") Observação: |
|---|
Você também pode adicionar comentários ao código precedendo o texto com o REM palavra-chave. No entanto, o símbolo ' e os botões Comment/Uncomment são mais fácil de usar e exigem menos espaço e memória. |