This page has 0 threads | Add post

Blogs

Finding our blogs useful? Please consider helping us to share more!

Commenting out code in VBA Part one of a three-part series of blogs
Commenting code is an art form! This series of blogs explains why, how and when to comment in VBA. Why Write Comments in Excel Visual Basic (this blog) Adding Comments in VBA macros for Excel Commenting Out Code in Excel Visual Basic This blog is part of our Excel macros online tutorial series. Alternatively, come on one of our VBA classroom training courses.

Commenting out code in VBA

Part one of a three-part series of blogs

Commenting code is an art form! This series of blogs explains why, how and when to comment in VBA.

Why Write Comments in Excel Visual Basic (this blog)
Adding Comments in VBA macros for Excel
Commenting Out Code in Excel Visual Basic

This blog is part of our Excel macros online tutorial series. Alternatively, come on one of our VBA classroom training courses.

Posted by Andy Brown on 28 April 2011

Why Write Comments?

All good programmers use comments liberally. To see why, consider the following excerpt of code, taken from Excel VBA:

Range("A1").Select

ActiveCell.End(xlDown).Select

ActiveCell.Offset(1, 0).Select

ActiveCell.Value = InputBox("Choose a Wise Owl")

Now compare this with exactly the same code, but commented:

'go to the bottom of column A

Range("A1").Select

ActiveCell.End(xlDown).Select

'go one cell further, to first blank cell …

ActiveCell.Offset(1, 0).Select

'… and set the value of this cell to be the Wise Owl name typed in

ActiveCell.Value = InputBox("Choose a Wise Owl")

We think the second code excerpt is far easier to read and understand!

Here are 2 good reasons to use comments in your code:

Reason	Notes
Intelligibility	You may understand your code now, but will you know what it was meant to do when you revisit it in 6 months' time? Will your colleague understand it when you leave your company? Comments make code easier to read and follow.
Clearer thought process	It sounds strange to say it, but commenting code as you write will help you think about what you're trying to do. If you write the line: 'go to the bottom cell in the first column you've already thought about what you're trying to achieve, and are more likely to translate this into code correctly.

As a rough guide, you should add a comment for every 2-3 lines of code on average.

That's why you should comment your VBA code - now read on for how to do it!

Parts of this blog
Why Write Comments in Excel Visual Basic (this blog) Adding Comments in VBA macros for Excel Commenting Out Code in Excel Visual Basic

Some other pages relevant to the above blogs include:

This blog has 0 threads

Add a new post

Head office

Kingsmoor House

Railway Street

GLOSSOP

SK13 2AA

London

Landmark Offices

99 Bishopsgate

LONDON

EC2M 3XD

Manchester

Holiday Inn

25 Aytoun Street

MANCHESTER

M1 3AE

Site map

Terms & Conditions

Book any course as classroom, onsite or online training, or as one-to-one consultancy

Free resources

Paid services

Getting help

Where we are

Where you are

Online

Transparent reviews

Delivery of courses

Nicer to work with

Reliable and established

Our training courses

C#

Excel

MySQL

Power Apps

Power Automate

Power BI and DAX

Python

Report Builder

SQL

SQL Server

VBA Macros

Other training resources

Blogs

Exercises

YouTube tutorials

YouTube shorts

Test your skills

Consultancy

Courseware

Self-paced courses

Newsletters

Publications

Our training venues

London

Manchester

Across the UK

At your site

Online

Why we are different

Hundreds of published reviews

Small class sizes

Outstanding courseware

Online classroom

(Almost) no cancellations

Wise Owl trainers only

Genuine integrity

Invoices after training

30+ years of Wise Owl

Our top 100 clients

BLOGS BY TOPIC

BLOGS BY AUTHOR

Why Write Comments?

Head office

London

Manchester