Visual Basic Naming Conventions in VB5 & VB6

   Dim nCount        As Integer
   Dim sQuery        As String
   Dim cUser         As New Cperson

   Private nPiCount              As Integer
   Private sPiQuery              As String
   Private cPiUser               As New Cperson

   Public nGbCount               As Integer
   Public sGbQuery               As String
   Public anGbThisArray()        As Integer

   Private Sub ClearGrid()

   Private Sub DeleteImportantInfo()

   Private Function nNextItem() as Integer

   Private Function sGetPath (byVal sFileName As String) As String

   Public Sub GbClearGrid()
   Public Function nGbNextValue() As Integer

   Dim frmNewBrowser As New frmSaleBrowser

   Const DEFAULT_KEY             As String = "VBMAHJONGG"
   Const DEFAULT_SECTION         As String = "DATABASE INFO"

   Type UDTPerson
      sFullName   As String
      nSalary     As Integer
   End Type

    Dim udtNewUser          As UDTPerson
    Dim cNewOpp             As New Copportunity

Coding Conventions

1. Do not use global variables. This means literally NO global variables. Understanding class modules and the (finally) ability to treat forms as objects in VB5 makes it unnecessary to have any global variables. Why not? Well the short answer is that global variables create a possible dangerous interdependency between different parts of your program. They are also difficult to trace properly. If you need to share information between objects or forms, make that information a property or method of your object, do not use a global variable. A global variable is easy to define and use initially, but they ALWAYS create more problems then they solve in the long term. Some applications have a particular functionality that may seem to lend itself to a small number of global variables. An example of this could be a global instance of a User class. This could be seen as acceptable because the nature of this variable is truly global, in the sense that it could be needed in every part of the application. For the most part, you should never have more global variables than you can count on one hand.
    
2. Do not use user-defined types. This means anything with the Type statement in it. These structures were quite effectively replaced by classes in VB5. If you have something that is a candidate for a user-defined type, then it is a candidate for a class. Besides classes are more powerful and FUN! There is one exception to this rule, that is if you are calling a DLL that requires a structure.
    
3. Do not pass function parameters by reference. Unfortunately, the default way in which variables are passed in Visual Basic is by reference. Prefix all of your sub and function parameters with the keyword ByVal. There are a million reasons not to pass by reference, but mainly it is very hard to trace a bad value if a called procedure is (knowingly or unknowingly) modifying your variable in memory.

• Be verbose rather than terse.
• Parenthesize _expression to make them clearer.
• Code for clarity, not efficiency.
• Limit the scope of variables, constants, functions and subroutines. If you have the choice, always use local objects instead of global ones.
• Use explicit type conversions (Cint, Cstr, and so on) when assigning different variable types.

• Define all variables explicitly. Option Explicit enforces this, and you can force Option Explicit in all objects by checking the Require Variable Declaration under the Tools > Options > Editor.
• Always specify the upper and lower bounds in an array definition.
• Define constants, and use them in place of hard-coded numbers in your code.
• Always use the ByVal and ByRef keywords in the parameter lists of your subroutines and functions. You should generally not use ByRef at all (see Changing Your Approach above)
• Always use the Private keyword on functions and subroutines that are not used outside of a module.
• Declare all variables explicitly. Dimensioned variables are variant if no type is supplied but you should always supply a type, even if that type is variant (e.g Dim nX As Integer, Dim vThing as Variant). This also applies to subroutines and functions. Such as Function sTest () as String instead of Function sTest().
• Do not use implicit type suffixes such as ! and & in variable definitions.
• In For loops, use Next instead of just next.

• Indent your code to 4 spaces. This setting is available in the code settings sections available through Tools>Options>Editor.
• Punctuate your code with blank lines.
• Keep your procedures to a manageable size, preferably not more than a single screen.
• Keep your indentation under control, if you are having difficulty remaining within the right margin, you are probably nesting too deeply.
• Use Parenthesis to enhance the readability of your code. People should be able to tell what a given formula does at first glance.

      Const MAX_LINES = 200   'The max lines allowable in grdOne

      Dim nX As Integer       'used to index record counting loop in my VB program!

'***************************************************************
'* Module:        Utilities
'*
'* File Name:     util.bas
'*
'* Author:        Orville Chomer
'*
'* Description:
'*
'* This module contains all of the generic utilities used
'* in the cool Chomer.com application.
'*
'*
'*
'* Revisions:
'*---date------rev. by--------------brief descr.-----------------
'*  1.27.2006   O.Chomer     added instance checking
'*
'*
'***************************************************************

'***************************************************************
'* Synopsis:   Initialize the Opp Browser form
'*
'*
'* Parameters:
'*----name------------------[I/O]--description------------------
'*
'*
'* Nonlocal Data:
'*----name------------------[I/O]--description------------------
'*
'*
'*
'* Description:
'*  - init forms and private variables
'*  - init the user selection tree, or load if management
'*  - check user permissions to use the form
'*  - load the grid with current opps
'*
'* > O.Chomer 11/2/05
'***************************************************************

Type Prefixes