VBA Coding Standards: Naming Conventions, Comments & Structure

Consistent code is easier to read, maintain, and test.

Tired of writing boilerplate? The VBA Code Generator creates clean, well-structured code with proper naming, comments, and error handling—automatically.

---

Naming

• Modules: modReports, modUtilities
• Procedures: CreateMonthlyReport, LoadConfig
• Variables: lastRow As Long, customerName As String
• Constants/Enums: Const MAX_ROWS As Long = 100000

---

Structure

• One responsibility per procedure
• Avoid global state; pass parameters
• Split into Subs (actions) and Functions (calculations)

---

Comments & documentation

• Explain why, not just what
• Header block per module/procedure
• Use XML-like tags if you generate docs

---

Options & settings

Option Explicit
Option Compare Binary

---

Example skeleton

' Creates a monthly revenue report for the given month
Public Sub CreateMonthlyReport(ByVal monthId As Long)
    On Error GoTo CleanFail
    Application.ScreenUpdating = False

    ' 1) Load data
    ' 2) Transform
    ' 3) Output

CleanExit:
    Application.ScreenUpdating = True
    Exit Sub
CleanFail:
    Resume CleanExit
End Sub

---

Checklist

• Consistent names
• Small procedures
• Comments explain intent
• Error handling present
• Performance toggles where needed

---

Let AI write clean code for you

Don't want to remember all these rules? Download the VBA Assistant and let AI generate clean, well-documented code—10 queries free.