Ao trabalhar com a codificação VBA no Excel, você pode adicionar comentários facilmente enquanto escreve o código.
Os comentários no VBA podem ser realmente úteis para iniciantes, onde você pode adicionar um comentário a uma linha de código (ou um bloco de código) que explica o que ele faz. Portanto, da próxima vez que você voltar ao código, não estará completamente perdido e terá algum contexto por causa dos comentários.
Mesmo para programadores Excel VBA avançados, uma vez que o código começa a ir além de algumas linhas, é uma boa ideia adicionar contexto usando comentários (especialmente se houver uma chance de que outra pessoa possa ter que trabalhar no código no futuro)
E como é um comentário, o VBA o ignora enquanto executa o código.
Neste breve tutorial do Excel, irei cobrir como adicionar comentários no VBA e todas as melhores práticas em torno dele.
Adicionando comentários em VBA no Excel
Para adicionar um comentário em VBA, basta adicionar um apóstrofo antes da linha que deseja marcar como comentário.
Qualquer coisa após o sinal de apóstrofo nessa linha seria considerado um comentário e o VBA o transformaria na cor verde (para diferenciá-lo visualmente do código normal)
Existem duas maneiras de adicionar um comentário no VBA:
- Ter um comentário em uma linha separada, onde esta linha começa com um apóstrofo e tem o texto do comentário depois dele
- Ter um comentário como parte da linha de código regular, onde após o código você tem um caractere de espaço seguido por um apóstrofo e, em seguida, o comentário (conforme mostrado abaixo)
Embora eu tenha visto ambos sendo usados pelos programadores VBA, prefiro o primeiro método em que um comentário tem uma linha separada.
Outro método (antigo) de adicionar um comentário é colocar a palavra 'Rem' seguida pelo comentário.
Aqui Rem é a abreviatura de Remark.
Rem foi usado na época do BASIC e foi mantido nas versões atuais do VBA. Embora seja bom saber que ele existe, recomendo que você use apenas o método de apóstrofo ao adicionar comentários em VBA.Convertendo uma linha de código (ou bloco de código) em comentário
Às vezes, pode ser necessário converter uma linha de código existente (ou um bloco de código) em comentários.
Os programadores costumam fazer isso quando estão trabalhando em um código e querem experimentar outra coisa rapidamente, enquanto mantêm o código já escrito.
Assim, você pode comentar rapidamente uma linha, tentar uma nova e, se quiser obter o código anterior de volta, apenas remova o apóstrofo e converta esse comentário de volta em uma linha normal de código.
Para uma linha (ou mesmo algumas linhas), é melhor adicionar manualmente o apóstrofo antes dessas linhas.
Mas se você tiver um grande bloco de código, use as etapas abaixo para adicionar a opção de converter um bloco inteiro de código em um comentário:
- Clique na guia Exibir
- Vá para a opção Barra de Ferramentas.
- Ao passar o cursor sobre ele, você verá mais opções
- Clique na opção Editar. Isso fará com que a barra de ferramentas de edição apareça em algum lugar da tela.
- Arraste as barras de ferramentas de edição em direção à área da barra de ferramentas para que ela se encaixe lá (caso ainda não esteja encaixada)
- Selecione o bloco de código que deseja comentar
- Clique na opção ‘Bloco de comentários’ na barra de ferramentas
As etapas acima converteriam instantaneamente um bloco de código em comentários, adicionando um apóstrofo na frente de cada linha nesse código.
Caso você queira remover o comentário e convertê-lo de volta em linhas de código normais, selecione esse bloco de código novamente e clique na opção ‘Bloco de descomentar’ na barra de ferramentas Editar
Alterando a cor do comentário no Excel VBA
Embora o VB não permita muita formatação, ele permite que você altere a cor do comentário se desejar.
Um dos meus alunos do curso VBA me enviou um e-mail e me disse que a capacidade de alterar a cor dos comentários no VBA era muito útil para pessoas que sofrem de daltonismo.
Abaixo estão as etapas para alterar a cor do comentário no Excel VBA:
- Abra o Editor do Visual Basic
- Clique na opção Ferramentas no menu
- Clique em Opções
- Na caixa de diálogo Opções, clique na guia ‘Formato do Editor’
- Nas opções de cores de código, selecione Texto do comentário
- Mude o primeiro plano e / ou a cor de fundo
- Feche a caixa de diálogo
Quando você altera a cor do comentário, também altera a cor de todos os comentários existentes em seu código.
Algumas práticas recomendadas ao trabalhar com comentários no VBA
Aqui estão algumas das práticas recomendadas a serem lembradas ao usar comentários no código VBA.
- Mantenha o comentário significativo e adicione contexto. Ao adicionar um comentário, considere o que seria útil para um novo usuário que nunca viu esse código e está tentando entendê-lo.
- Evite comentários excessivos, pois isso faria seu código parecer um pouco confuso. Embora seja normal adicionar mais comentários quando você é um iniciante, à medida que ganha mais experiência na codificação VBA, você não precisaria adicionar muitos comentários.
- Para cada nova sub-rotina ou função, é uma boa ideia adicionar um comentário que explica o que ela faz.
- Ao trabalhar com código complexo, é uma boa ideia adicionar comentários antes das condições e loops, para que seja mais fácil para você entender o que fez ao revisitar o código (ou quando outra pessoa lê o código)
Neste tutorial, falei sobre como você pode adicionar comentários em VBA e algumas práticas recomendadas para usá-lo.
Espero que você tenha achado este tutorial útil.
