Setting VBA/VB6 Module Coding Standards in Total Visual CodeTools

The commenting section is divided into six tabs:

• The General tab for settings that apply to all the commenting options
• Code Cleanup commenting options:
  • Cleanup Mod for comments to add in the General Declarations section of modules (can include procedure lists of the module)
  • Cleanup Proc for the comments to add to procedures
  • Cleanup Prop for the comments to add to properties
• New Proc for the comments to add in the New Procedure Builder
• New Prop for the comments to add in the New Property Builder

The General Tab options are:

• Your name and initials which can be referenced in the comments
• The comment string to be used in the Block Commenter feature
• Whether to place procedure comments before or after the Sub/Function line
• How date and time references should be formatted

The other tabs let you specify your comment structure with the use of tokens to reference the module name, procedure lists, procedure name, procedure type, your initials, the current date/time, etc.

Here's an example of the Cleanup Module tab with the list of Token Definitions displayed. When Code Cleanup adds this to a module, the #M# token is replaced with that module's name, #V# is replaced with the list of procedures in the module, #D# with the current date, and #I# with the developer's initials.

For the New Procedure tab, there are separate comment structures for Functions vs. Subs:

Here's more information on the New Procedure Builder.

Similar to commenting, you can specify your own error handler to apply to different situations. The Error Handling section is divided into four tabs.

The first tab is Cleanup Options for Code Cleanup if you choose to add error handling to procedures that lack it. Here you can optionally determine if you want to add error handling to property procedures (Let, Get, and Set), and determine if you want to update any existing error handling that is tagged with Total Visual CodeTools comments (or specify your own tags):

You can specify unique error handling structures for classes, regular modules, and forms/reports. Here's an example of the Modules tab showing the error handling text that goes at the top of the procedure (after comments) and the code at the end of the procedure:

The error handling text can be customized to be much more sophisticated to let you pass information such as the module name #M# and procedure name #P#. The #X# passes Sub or Function depending on the procedure being updated.