VB Documentation Tool description
The VB Documentation Tool creates comprehensive technical documentation for Visual Basic 6.0 projects.

The VB Documentation Tool is a powerful and reliable application that creates comprehensive technical documentation for Visual Basic 6.0 projects. It will also document SQL Server 7.0,2000,2005 and Microsoft Access databases associated with the projects.

Reports are created in HTML, Microsoft's HTML Help and text formats. Color coded, syntax highlighted copies of the Visual Basic source code is included with the reports.

The compiled HTML Help reports include fully searchable source code, making the VB Documentation Tool an invaluable utility in understanding your (or someone else's!) Visual Basic 6.0 applications.

A number of programming languages have well defined documentation schemes that make it straightforward to generate low level documentation. Examples are Java's JavaDoc (see sample output) and Perl's PerlDoc. Unfortunately there is no such system for Visual Basic, so creating technical documentation for a Visual Basic application is usually an afterthought.

The VB Documentation Tool has been created to address a major problem encountered with applications developed using Visual Basic: they are often poorly documented. The VB Documentation Tool addresses this issue by creating comprehensive technical documentation for Visual Basic project files. It also has the ability to document SQL Server 7.0 and 2000 databases.

The VB Documentation Tool examines the Visual Basic source code files that make up a web project, and compiles a report about that project in standard HTML format.

Limitations:

· NET: The VB Documentation Tool does not document .NET or VB.NET. A separate .NET Documentation Tool is available, which documents both VB.NET and C# applications.
· Documentation of databases: Microsoft SQL Server 7, 2000 and 2005 databases can be documented. Microsoft Access databases can also be documented. The VB Documentation Tool has been tested with databases in Access 95, Access 97 and Access 2000 formats. Due to problems with the ADOX technology used there are no guarantees that every database will be properly documented. SQL Server databases are documented by making use of SQL Server's system stored procedures, instead of using ADOX. The VB Documentation Tool does not document the new features in SQL Server 2005.
· Duplicate entities: Duplicate function or subroutine names within the same project will cause inconsistencies in the report.
· Line Parsing: The script parses VB source code on a line by line basis. As a result there is limited support for multi-line statements using VB's underscore end of line marker. The exception to this is function and subroutine arguments which the VB Documentation Tool correctly understands.
· Parsing: The script has been extensively checked with a wide variety of source code, but there is no guarantee that it will correctly document your application. If you find any code that causes problems, then send it in!
· Application Size: Very large VB applications will require a lot of RAM in order to document them. RAM requirements are difficult to estimate, but as a general rule the VB Documentation Tool can document sites containing up to 512 files on most desktop machines.