Commentarian Instructions

Usage

Standalone Version

Start the program from the Startmenu or directly with the commentarian.exe.

Use the mouse or the keyboard shortcuts to set the options wanted, enter data and click Copy To Clipboard.

Now change to your development tool (whatever language) and simply paste it in with ordinary Paste tool!

VB6 IDE Version

Place the cursor where You want the comment, invoke the add-in from the Add-In menu(or by pressing ALT+A and then ALT+C).
Use the mouse or the keyboard shortcuts to set the options wanted, enter data and click OK.
Viola! Instant comment!

Note! The version has to be entered manually(Only needed to do this once though:)

Install instructions

To install, unzip zipfile into a suitable folder and run the setup.exe provided. This will install the standalone version and register the VB6 IDE dll as well.

 

Comment Types

Module

VB 6 IDE Version Help function: Gets the module name from the VB IDE

Output:

' ******************************************************************************
' Project:     MasterPlan
' Module:      frmMain
' Description: Main startup form of this program
' ==============================================================================
' Date       Version  Author                         Description
' ---------- -------- ------------------------------ ---------------------------
' 2002-12-02 1.0.0    Anders Forslund                Module created
' ******************************************************************************
'

Routine

VB 6 IDE Version Help functions: Gets all methods(subs, events & functions) from the current module into a dropdown combobox.

OutPut:

' ******************************************************************************
' Routine:       GetTitle
' Description:   returns the table files title
' Parameters:    full pathname to the file
' Returns:       string
' Special Logic: none
' ==============================================================================
' Date       Version  Author                         Description
' ---------- -------- ------------------------------ ---------------------------
' 2002-12-02 1.0.0    Anders Forslund                Routine created
' ******************************************************************************

Section

Output:

'
' <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
'
'                               Variable Declaration
'
' <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
'

Heavy Comment

Output:

' ------------------------------------------------------------------------------
' initialize random generation
' ------------------------------------------------------------------------------

Comment

Output:

' --------------------------------
' initialize random generation
' --------------------------------

Project

VB 6 IDE Version Help functions: Gets the project name from the IDE

Output:

' ******************************************************************************
' Project:     MasterPlan
' Description: Utility for gamemasters of roleplaying games
'              <or>
'              anyone with the desire to generate random items from a
'              table
' Author:      Anders Forslund
' Email:       anderware@playful.com
' URL:         http://www16.brinkster.com/anderware
' ==============================================================================
' Date       Version  Author                         Description
' ---------- -------- ------------------------------ ---------------------------
' 2000-03-27 1.0      Anders Forslund                Project created
' 2002-11-28 1.7      Anders Forslund                Added the MasterPlan Explorer
' ******************************************************************************
'

Separator

Output

' ==============================================================================