Add comments to End If and Loop statements

Here’s a little programming tip that will save you hours of headacheslater.

Most of us already indent our Ifs, Selects, Do…Loops, etc., and that is good. But suppose you have some fairly complex code with several levels of indentation. Example:

If A= 0 and B=1 then    ' ...(several lines of code)    If C < 0 and D > 0 then        ' ... (several more lines of code)        Do while E > 0            ' ... (several more lines of code)            If F <> G or H < I then                Do While J < 0                    ' ... (several more lines of code,                     '      with several more If -EndIf blocks)                Loop                ' ... (several more lines of code)            End If            ' ... (several more lines of code)        Loop        ' ... (several more lines of code)    End If    ' ... (several lines of code)End If

It does get a little confusing as to which End If goes with which If, etc, because the original statement has scrolled up off the screen. My suggestion is this: modify your programming style slightly so that you create your If – End If or Do – Loop statements together and comment the End or Loop statement with the conditional clause. Example:

If A= 0 And B=1 Then    ' ...End If ' A= 0 and B=1 

Now put your cursor in the blank line and continue programming. Do this for every pair and you will wind up with our example above looking like this:

If A= 0 and B=1 then    ' ... (several lines of code)    If C < 0 and D > 0 then        ' ... (several more lines of code)        Do While E > 0            ' ... (several more lines of code)            If F <> G or H < I then                Do While J < 0                    ' ... (several more lines of code,                     '      with several more If-EndIf blocks)                Loop 'While J < 0                ' ... (several more lines of code)            End If ' F <> G or H < I             ' ... (several more lines of code)        Loop ' while E > 0        ' ... (several more lines of code)    End If ' C < 0 and D > 0     ' ... (several lines of code)End If ' A= 0 and B=1 

Of course you can use the same approach with other VB code blocks, such as For-Next loops and Select Case clauses.

Our code is now much easier to maintain. You will be quite happy you did this when you re-visit the code in six months, and believe me, the person who takes your place when you leave will bless you in their prayers at night!

Share the Post:
Share on facebook
Share on twitter
Share on linkedin

Overview

The Latest

microsoft careers

Top Careers at Microsoft

Microsoft has gained its position as one of the top companies in the world, and Microsoft careers are flourishing. This multinational company is efficiently developing popular software and computers with other consumer electronics. It is a dream come true for so many people to acquire a high paid, high-prestige job

your company's audio

4 Areas of Your Company Where Your Audio Really Matters

Your company probably relies on audio more than you realize. Whether you’re creating a spoken text message to a colleague or giving a speech, you want your audio to shine. Otherwise, you could cause avoidable friction points and potentially hurt your brand reputation. For example, let’s say you create a

chrome os developer mode

How to Turn on Chrome OS Developer Mode

Google’s Chrome OS is a popular operating system that is widely used on Chromebooks and other devices. While it is designed to be simple and user-friendly, there are times when users may want to access additional features and functionality. One way to do this is by turning on Chrome OS