Glossary Item Box

VB6 Documentation (Visual Basic 6) and VBA Documentation (Visual Basic for Applications)

Document! X is a combination of an automated API (SDK) or technical reference documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality VB6 documentation or VBA documentation.

Author content in source comments and/or external to source

Using the unique Document! X Visual Comment Editor integrated directly into the VB6 (Visual Basic 6) and VBA (Visual Basic for Applications) environments, you can create and edit comments in your source code within a preview of how the generated documentation page will look. You can also author content in Document! X Content Files if you would like to maintain some or all of the documentation content outside of the source code.

Whenever you wish you can build a full documentation set (to compiled HTML Help 1.x CHM file, or web ready browser help) that contains both the automatically generated documentation content and the additional content you have authored in source comments - automatically.

Benefits of automated documentation

Using an automated documentation tool immediately delivers the following benefits:

  1. Documentation can be built by Document! X in moments, reducing the amount of manual effort involved in creating a documentation set to virtually zero;
  2. The documentation generated by Document! X (including Syntax sections, type information, parameter lists) is accurate and always up to date. Creating the same documentation manually is error prone;
  3. Producing a documentation set for your VB6 projects makes your source code more maintainable as other developers have a reference to accompany the code;
  4. Authoring your source comments in the Document! X Visual Comment Editor

Integrated Visual Comment Editor

Document! X includes a Visual Comment Editor integrated directly into the Visual Basic 6 and VBA Visual Basic for Applications IDE. The Visual Comment Editor allows you to author your source comments in a fully Visual environment - so that you can see exactly what the finished documentation will look like. Type your content directly within a preview of the generated page and Document! X writes back the content you have created to your source code as comments.

VB6 (Visual Basic 6) Visual Comment Editor
Click to EnlargeClick to Enlarge

Specific designers for complex content

In addition to creating descriptive content (summary, remarks etc.), Document! X includes specific designers for creating See Also links, hyperlinks to other members in your source code, Index keywords and colorized example code.