Comentários no VBA

Este artigo o ensinará a comentar uma única linha ou vários blocos de código no Editor VBA. Em vez disso, se você quiser saber como interagir com os comentários de células do Excel usando o VBA, leia esse artigo.

Comentário VBA de uma Única Linha

No Excel VBA, há várias maneiras de comentar linhas de um código:

• Aspas simples (‘)
• Botão Comentar bloco na barra de ferramentas
• Adicionando a palavra-chave Rem.

A maneira mais fácil de comentar uma linha de um código é colocar uma aspa simples no início da linha:

   'Planilha1.Range("A1").Value = "Teste"

Observe que, no VBA, os comentários são sempre exibidos como texto verde.

Como você pode ver no exemplo, colocamos uma aspa simples no início da primeira linha do procedimento e a comentamos. Se uma citação for colocada no início da linha, toda a linha será comentada e será ignorada durante a execução do código.

Você também pode comentar parte do código se colocar uma aspa simples em algum ponto da linha.

Nesse caso, o código após uma citação será ignorado:

   Planilha1.Range("A1").Value = "Teste"  'O exemplo de comentário de linha parcial

Agora comentamos apenas parte da linha. Essa é uma boa maneira de escrever comentários em linha em um código.

A segunda maneira de comentar uma linha em um código é usar o botão padrão do VBA para comentários na barra de ferramentas. Para exibir esse botão, você precisa adicioná-lo: Exibir -> Barras de ferramentas -> Editar. Agora você pode ver dois botões na barra de ferramentas: Comentar Bloco e Remover Comentário do bloco.

Basta destacar a(s) linha(s) de código desejada(s) e clicar em um dos botões. Isso comentará/descomentará linhas inteiras. Observe que esse método não permitirá que você adicione um comentário ao final de uma linha de código.

Você também pode usar a palavra-chave Rem. Para comentar uma linha, você precisa colocar essa palavra-chave no início de uma linha:

Rem   Planilha1.Range("A1").Value = "Teste"

Da mesma forma que o botão de comentário, a palavra-chave Rem permite que você comente apenas uma linha inteira de um código, o que significa que você pode colocá-la apenas no início de uma linha:

Comentário VBA de Todo o Bloco

Além de comentar uma única linha, muitas vezes precisamos comentar várias linhas, um bloco de código. Para fazer isso, podemos usar o mesmo botão padrão Comemtar bloco na barra de ferramentas que usamos para comentar uma única linha. Primeiro, precisamos selecionar todas as linhas que queremos comentar e, em seguida, clicar no botão:

Private Sub ComentarBlocoInteiro()

'    Planilha1.Range("A1").Value = "Teste"

'    If Planilha1.Range("A1") = "Teste" Then
'        MsgBox "O valor da célula A1 é: Teste"
'    End If

End Sub

Como resultado, todo o bloco de código é comentado.

Da mesma forma, podemos descomentar um bloco clicando no botão Remover comentário do bloco na barra de ferramentas:

Private Sub ComentarBlocoInteiro()

    Planilha1.Range("A1").Value = "Teste"

    If Planilha1.Range("A1") = "Teste" Then
        MsgBox "O valor da célula A1 é: Teste"
    End If

End Sub

Atalhos de Teclado para Comentar no VBA

Para ativar os atalhos de teclado para comentários:

• Clique com o botão direito do mouse em um espaço vazio da barra de ferramentas.
• Escolha a opção Personalizar e selecione Editar nas categorias.
• Localize Comentar bloco em Comandos e arraste e solte-o ao lado dos ícones existentes na barra de ferramentas.
• Agora você pode ver o botão recém-adicionado na barra de ferramentas
• Clique em Modificar seleção e marque a opção Imagem e texto.
• Clique novamente em Modificar Seleção e, em Nome, adicione um E comercial (&) no início do nome, de modo que o nome do botão seja “&Comentar bloco”.

Agora você pode selecionar uma única linha ou um bloco de código e pressionar Alt+C no teclado para comentar.

Para ativar a mesma opção para descomentar um código, você pode repetir todo o processo para o comando Remover comentário do bloco. O atalho para descomentar é ALT+U.