Binaryworld - Add comments to End If and Loop statements ... [ VB -> IDE ]

Here's a little programming tip that will save you hours of headaches later.

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:

Click here to copy the following block

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:

Click here to copy the following block

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!