Comentários no código (Visual Basic)
Ao ler os exemplos de código, você frequentemente encontra o símbolo de comentário ('). Esse símbolo diz ao compilador do Visual Basic para ignorar o texto que o segue ou o comentário. Os comentários são breves notas explicativas adicionadas ao código para benefício de quem o lê.
É uma boa prática de programação começar todos os procedimentos com um breve comentário descrevendo as características funcionais do procedimento (o que ele faz). Isto é para seu próprio benefício e para o benefício de qualquer outra pessoa que examine o código. Você deve separar os detalhes da implementação (como o procedimento faz isso) dos comentários que descrevem as características funcionais. Ao incluir detalhes de implementação na descrição, lembre-se de atualizá-los quando atualizar a função.
Os comentários podem seguir uma declaraçã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 o comentário exigir mais de uma linha, use o símbolo de comentário em cada linha, como ilustra o exemplo a seguir.
' 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 quais tipos de comentários podem preceder uma seção de código. 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 do comentário |
|---|---|
| Propósito | Descreve o que o procedimento faz (não como o faz) |
| Suposições | Lista cada variável externa, controle, arquivo aberto ou outro elemento acessado pelo procedimento |
| Efeitos | Lista cada variável, controle ou arquivo externo afetado e o efeito que ele tem (somente se não for óbvio) |
| Entradas | Especifica a finalidade do argumento |
| Devoluções | Explica os valores retornados pelo procedimento |
Lembre-se dos seguintes pontos:
Toda declaração de variável importante deve ser precedida de um comentário descrevendo o uso da variável que está sendo declarada.
Variáveis, controles e procedimentos devem ser nomeados com clareza suficiente para que comentários sejam necessários apenas para detalhes complexos de implementação.
Os 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 para um bloco de código selecionando uma ou mais linhas de código e escolhendo os botões Comentar (
) e Descomentar (
) na barra de ferramentas Editar.
Nota
Você também pode adicionar comentários ao seu código precedendo o texto com a REM palavra-chave. No entanto, o ' símbolo e os botões Comentar/Descomentar são mais fáceis de usar e requerem menos espaço e memória.
