Compartilhar via

Comentários em código (Visual Basic)

Ao ler os exemplos de código, você geralmente 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 anotações explicativas adicionadas ao código em benefício daqueles que o leem.

É uma boa prática de programação iniciar todos os procedimentos com um breve comentário descrevendo as características funcionais do procedimento (o que ele faz). Isso é 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) de comentários que descrevem as características funcionais. Ao incluir detalhes de implementação na descrição, lembre-se de atualizá-los ao 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 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ário

A tabela a seguir fornece diretrizes gerais para quais tipos de comentários podem preceder uma seção de código. Estas são sugestões; O 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 ele faz)
Suposições Lista cada variável externa, controle, arquivo aberto ou outro elemento acessado pelo procedimento
Efeitos Lista cada variável externa afetada, controle ou arquivo e o efeito que ela 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:

  • Cada declaração de variável importante deve ser precedida por um comentário que descreve o uso da variável que está sendo declarada.

  • Variáveis, controles e procedimentos devem ser nomeados claramente o suficiente para que o comentário seja necessário 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 o Comentário (o botão Comentário do Visual Basic no Visual Studio.) e o Descomentar (o botão Descomentar do Visual Basic no Visual Studio.) na barra de ferramentas Editar.

Observação

Você também pode adicionar comentários ao código antes do 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 exigem menos espaço e memória.

Consulte também