MAPS Caregiver Script Generator - Code

The MAPS Caregiver Script Generator is a Visual Basic 6 application. The code adheres to Visual Basic coding and documentation standards.

Visual Basic Coding Standards

Naming Conventions.

All constants are named in all caps: CONSTANTS. Global variables are named with the first letter in caps: Global. Longer names user in-word caps instead of underscores: LongVarOrFunctionName. All functions and variables are usefully named. The only exception is simple counters for loops which may just be a letter (i,j,k,n...).

Documentation.

Every function begins with a four line comment listing the initials and date of the last edit, a list of where the function is called from, what the function does, and if there are any tricky/weird parts and how they work.

There is an extensive debug_notes module which contains the design rational and list of bugs and their fixes for the life of the application. There are also extensive inline comments describing the specific actions of lines of code.

Project organization.

The project is broken down into the various forms of the application as well as several logical modules of reasonable size. Separate modules include the DB (for database) module, utility, sound, variable declaration, display, IO, and gui edit modules.