When writing a long and complex code in VBA, it is essential to add comments for better understanding and debugging. This is where the Rem statement comes in handy. Rem stands for ‘Remark’ and it is used to add comments in the code. In this blog post, we will discuss the purpose, syntax, examples, important notes and remarks, and conclude with seeking feedback and views on the use of Rem statement in VBA.
VBA Rem Statement
Purpose of Rem Statement
The Rem statement is used to add comments or remarks in VBA code. Comments are non-executable statements that are ignored by the compiler and do not affect the code’s functionality. Their purpose is to provide explanations, descriptions, or documentation within the code for better understanding and future reference.
Syntax of Rem Statement
The Rem statement is followed by a space and then the comment. It can be used in a single line or multiple lines. In a single line, it starts with an apostrophe (‘) and the comment follows without any space. In multiple lines, it starts with Rem in the first line and the comment is written in the next lines until it is ended with ‘End’ keyword.
Examples of the VBA Rem Statement
Adding a Description
Dim a As Integer
Rem This variable stores an Integer Value
'This variable stores an Integer Value
a = 1
In the above example, the comment provides a description of the variable ‘a’ and what it is used for. This makes it easier for someone else reading the code to understand its purpose.
Note: You can use Single quote (‘), instead of Rem Statement to comment the code statements.
Documentation for Future Reference
Rem Open Workbook
In this example, the comment acts as a documentation for the code. It explains the action being taken and what file path is being used. This makes it easier to refer to the code in the future, especially when working with large and complex codes.
Disabling a Code
'x = 10
Sometimes, we might need to temporarily disable a code without deleting it. In such cases, we can use the Rem statement to comment out the code. In the above example, the code is commented out, and it will not be executed when the program is run.
If x > 0 Then
Rem Calculate Sum
y = x + z
'Return Error Message
In this code, the comments are used to provide explanation for each section and for better understanding while debugging. It helps in identifying which part of the code is producing an error or not functioning as intended.
Notating Code Changes
For i = 1 to lastRow
Rem Sum range
j = j + Range("A" & i)
When working on a team, it is essential to indicate any changes made in the code for better collaboration and communication. In this example, the comment includes the date and what change was made, making it easier for other team members to keep track of code modifications.
Important Notes and Remarks
- The Rem statement must be placed in a separate line and cannot be used inline with other code.
- We strongly recommend you to use Single Quotation Mark to comment the Code Statements, instead of Rem Statement.
- It is always a good practice to add comments in your code for better understanding and future reference.
- Comments do not affect the code’s functionality, but too many comments can make the code harder to read and maintain.
- Always use clear, concise and specific comments to avoid confusion and misinterpretation.
- The ‘ Rem’ statement can also be used to add comments in between a code line, just after the code.
In this blog post, we discussed the purpose and syntax of the Rem statement and provided the examples of its usage. We also mentioned some important notes and remarks to keep in mind while using the Rem statement in VBA code. Comments are an essential part of coding and can significantly improve the readability and maintainability of a codebase.
The Rem statement in VBA provides a simple and efficient way to add comments and provide explanations for better understanding and debugging. We would love to hear your feedback and views on the use of Rem statement in VBA code. We have used both Rem and Single Quote (‘) to comment the code statements in VBA.
I personally use Single quote (‘) to comment the code lines in VBA. Do you use the Rem statement in your VBA code? How has it helped you in your coding journey? Share your thoughts in the comments below.