VBA Comment Block

Updated on January 1, 2024
Article byTwinkle Sethi
Edited byAshish Kumar Srivastav
Reviewed byDheeraj Vaidya, CFA, FRM

Excel VBA Comment Block of Code

Comments in VBA programming are statements that are not executed or compiled but are only there to provide a brief description of any function, variable, statement, etc. These comments are not mandatory but are used to make the blocks of VBA code more informative, readable, organized, and easy to understand. Also, if we do not wish to delete certain lines of code and neither want them to execute, we can comment on them.

VBA Comment Block

You are free to use this image on your website, templates, etc, Please provide us with an attribution linkHow to Provide Attribution?Article Link to be Hyperlinked
For eg:
Source: VBA Comment Block (wallstreetmojo.com)

How to Comment on Block of VBA Code?

You can download this VBA Block Comment Template here – VBA Block Comment Template

Example #1 – Comment using Apostrophe

We wish to comment on a single line/statement/block in a VBA code. We must configure the Visual Basic Editor (VBE) to do this.

The Visual Basic Editor can be accessed as follows:

First, go to the Excel Developer tabExcel Developer TabEnabling the developer tab in excel can help the user perform various functions for VBA, Macros and Add-ins like importing and exporting XML, designing forms, etc. This tab is disabled by default on excel; thus, the user needs to enable it first from the options menu.read more, click “Visual Basic Editor,” or press Alt+F11 to open the “Visual Basic Editor” window.

VBA Block Comment Example 1

In doing this, a window opens as follows:

VBA Block Comment Example 1-1

Right-click on the workbook name in the “Project-VBAProject” pane and then click on “Insert” -> “Module” as follows.

VBA Block Comment Example 1-2

Now, we can write our code or procedure in this module:

Code:

Sub macro()

 'This is a Comment

End Sub
VBA Block Comment Example 1-3

So, we can see in the above screenshot that when writing this code in the module, when we put or insert an apostrophe before a statement/line, that statement turns into green text and is considered a comment. So, we see that when we wish to comment on a single line, it can precede us with an apostrophe.

We can also use this method to comment on multiple lines by putting an apostrophe before each line as follows:

VBA Block Comment Example 1-4

–>> If you want to learn Excel VBA professionally, then our VBA Basic Course (16+ hours) is the perfect solution. In our Basic Excel VBA course you learn the skill of automating tasks using Variables, Data Types, Ranges, and Cells in VBA. Master Control Structures, including Conditional Statements and Loops, and discover techniques for manipulating data through sorting, filtering, and formatting. By the end of the course, you will be able to apply your acquired skills to real projects, culminating in an Excel VBA project which will solidify your ability to create efficient, automated solutions.

Example #2 – Using Toolbar

Suppose we wish to skip over and comment on an entire block of code or multiple statements of the code. In such a case, using an apostrophe before each statement would be tedious and time-taking when we have so many statements to comment on. So to do this, there is a built-in option of “Comment/Uncomment Block” in VBA,  initially hidden in the toolbar, and we can use it as follows:

Step 1: Select the Statements from code.

Select the statements in the macro/procedure that must comment below.

VBA Block Comment Example 2
Step 2: Click on “View” -> Toolbars -> Customize
VBA Block Comment Example 2-1
Step 3: From “Customize” Window Click on “Commands” -> Edit, then select “Comment Block”

It will generate or open a “Customize” pop-up window. Now, click on “Commands” -> “Edit” and then click on “Comment Block” and drag it to the toolbar.

VBA Block Comment Example 2-2

With this, we now have the “Comment Block” icon on the toolbar for easy access.

Now, click on the “Comment Block” from the toolbar as follows:

VBA Block Comment Example 2-3

In doing so, the highlighted statements/lines would now be commented and turn out to be green in color as below:

Code:

Sub CommentLines()

 'MsgBox "First Comment Line"
 'MsgBox "Second Comment Line"
 'MsgBox "Third Comment Line"

End Sub
VBA Block Comment Example 2-4

So, we can see in the above screenshot that the green statements will not execute by the macro and will only be treated as comments blocks.

Example #3 – Using REM Keyword

Another method we can use to make a statement/line as a comment is adding the keyword ‘REM’ before it.

Let us see below how this works:

VBA Block Comment Example 3

We can see in the screenshot below that when we add the keyword “REM” before the statement: “This is a comment,” it turns out to be green and hence a comment.

VBA BlockComment Example 3-1

Now, let us see how we can use this keyword to comment on multiple lines in the below screenshot.

Code:

Sub CommentUsingRem()

 Rem This is a Comment
 Rem This is a Comment
 Rem This is a Comment

End Sub
VBA BlockComment Example 3-2

So, we can see that apart from using apostrophes and “Comment Block,” the keyword we can also use “REM” to comment statements of code or procedure. However, using the keyword “REM” has some limitations:

  • Space is mandatory between the keyword “REM”and the start of the statement.
  • It always has to be the first word to start with and cannot be used somewhere in the middle of a line/statement to comment on the rest of the line.

Example #4 – UnComment the Commented lines using Toolbar

Just the way we can comment a block of lines at one go, we can also uncomment the commented lines using the VBE built-in “Uncomment Block” option in the same way as follows:

Select the commented statements in the macro/procedure that we require to uncomment as below:

Block Comment Example 4

Now, select View -> Toolbars -> Customize.

Example 4-1

It will generate or open a “Customize” pop-up window. Now, click on Commands -> Edit, and then click on Uncomment Block and drag it to the toolbar as follows:

Example 4-2

With this, we now have the “Uncomment Block” icon on the toolbar for easy access.

Now click on the “Uncomment Block” from the toolbar as follows:

Example 4-3

For doing that, the highlighted statements that commented would now turn into executable statements of the code or procedure and change in color from green to black again as below:

Code:

Sub UncommentedLines()

 MsgBox "First Comment Line"
 MsgBox "Second Comment Line"
 MsgBox "Third Comment Line"

End Sub
VBA BlockComment Example 4-4

So, these statements are no longer comments.

Things to Remember

The following screenshot illustrates this:

Apostrophe Comment
  • The comments do not affect code performance.
  • The comment symbol: Apostrophe’, or “REM,” has to be used on each line if the comments require more than one line.
  • By default, the comments appear as green in the code window.
  • The advantage of using apostrophes and “Comment Block” over the keyword “REM” is that they need less memory and space and are also easier to use.

Recommended Articles

This article has been a guide to VBA Comment Block. Here, we learn three ways to comment blocks of VBA codes using 1) Apostrophe, 2) Toolbar, 3) REM keyword, practical examples and a downloadable Excel template. Below you can find some useful Excel VBA articles: –