Help Generator for VB6: Create Context-Sensitive Documentation Fast

Help Generator for VB6: Create Context-Sensitive Documentation Fast

What it is

A Help Generator for VB6 automates creating context-sensitive documentation (CHM/HTML Help) from a Visual Basic 6 project. It scans forms, controls, procedures, and comments to generate help topics and assign context IDs so users can press F1 or call HtmlHelp() at the relevant place.

Key features

• Source parsing: Extracts procedures, public methods, forms, and control names from VB6 code and form files.
• Automatic topic generation: Creates one help topic per procedure/form/control or groups related items into single topics.
• Context ID assignment: Generates and inserts context IDs for use with HtmlHelp API or VB6’s built-in F1 behavior.
• Output formats: Produces HTML files and a project for Microsoft HTML Help Workshop (.hhp) to compile CHM files.
• Index and TOC: Builds topic indexes and a hierarchical table of contents automatically.
• Comment extraction: Pulls developer comments (doc comments) into topic bodies, with optional formatting.
• Batch processing: Handles multiple projects or modules in one run.
• Custom templates: Lets you define HTML/CSS templates for consistent look-and-feel.
• Search/keywords: Adds meta keywords and searchable text for the compiled help.
• Integration hooks: Optionally inserts context ID code snippets into source or outputs mapping files for later use.

Typical workflow

1. Point the tool at a VB6 project (.vbp) or a folder of .frm/.bas/.cls files.
2. Configure grouping rules (per-procedure, per-form, or custom).
3. Run the generator to produce HTML topics, index, TOC, and a .hhp project.
4. Compile the .hhp with HTML Help Workshop to produce a CHM.
5. Optionally insert generated context ID constants into source and call HtmlHelp() where needed.

Benefits

• Saves time converting code comments and structure into a navigable help system.
• Ensures consistent context ID assignment, reducing collisions and manual errors.
• Makes legacy VB6 apps more user-friendly without extensive manual documentation work.

Limitations & considerations

• Accuracy depends on code comment quality and consistent naming in the source.
• Complex runtime-generated UI elements may require manual topic creation.
• CHM format has OS restrictions (blocked on some Windows versions if downloaded); consider also providing HTML output.

When to use it

• Migrating or maintaining legacy VB6 applications where end-user help or context-sensitive assistance is required.
• Creating documentation quickly for support teams or user manuals tied to specific UI elements.