Key Features of the VB Documentation Tool

The VB Documentation Tool creates technical documentation for Visual Basic 6.0 projects [Visual Basic 5.0 also supported]. Below is a summary of its key features:

• The VB Documentation Tool extracts content from Visual Basic 6.0 source code files. It supports the main Visual Basic file types:
  • Forms
  • Modules (.bas)
  • Class Modules (.cls)
  • Project Groups (.vbg files)

• Supports more than one input folder, which is useful if your application is comprised of multiple projects.

• The VB Documentation Tool creates documentation which shows the following:
  • Files associated with the project(s).
  • Functions: Where they are defined, and where in the project they are called from.
  • Subroutines: Where they are defined, and where in the project they are called from.
  • Properties, including where their Get and Let methods are defined.
  • Constants: Where they are defined, and where in the project they are used.
  • Databases associated with the project(s).

• SQL Server 7.0, 2000 or 2005 databases associated with Visual Basic projects can also be documented, with the following features:
  • Shows a list of tables within the database.
  • Shows a list of views within the database, including the SQL associated with each view.
  • Shows a list of column names, type and length associated with each table and view and whether the column can contain null values.
  • Shows a list of stored procedures, including the full text of each stored procedure and its input parameters.
  • Shows where the stored procedure is called from in the Visual Basic source code (provided the EXEC keyword is used in SQL statements or the stored procedures are prefixed with "sp_") Optional guess mode can detect stored procedure calls even if the EXEC keyword is not used or the stored procedures are not prefixed with "sp_".
  • Shows the relationships between table primary key and foreign key columns if the database contains relationships.
  • If you required it, the SQL Documentation Tool can be used to generate even more detailed database developer documentation for SQL Server databases - generous discounts are available if you purchase the SQL Documentation Tool at the same time as the VB Documentation Tool.

• Microsoft Access databases (Access 95, Access 97 and Access 2000) associated with the Visual Basic project(s) can also be documented, with the following features:
  • Shows a list of tables within the database.
  • Shows a list of views (i.e. "select" Queries) within the database.
  • Shows a list of column names, type and length associated with each table and view.
  • Shows a list of stored procedures (i.e. Queries that aren't considered views), including the full text of each stored procedure.
  • Shows where the stored procedure is called from in Visual Basic source code.

• There are a number of output options:
  • Standard HTML: This can be viewed in any web browser, including Internet Explorer and Firefox [sample].
  • Microsoft's HTML Help format: This format [sample] has the advantages of:
    • The project documentation is contained within a single, compressed .chm file.
    • The entire project documentation is searchable.
    • There is an index of project items.
    • The project documentation can be further modified using Microsoft's freely available HTML Help Workshop application.
  • Plain Text: This is a text file containing a summary of the project. As such it can be used as the basis of custom documentation written in a word processor [sample].

• Suggested uses of the VB Documentation Tool:
  • Use it on newly acquired projects to assist in obtaining an overview of that project. What coding style has the development team used? Does the code make use of many functions, subroutines, classes or modules? The VB Documentation Tool can help you to determine this... and much more!
  • Provide assistance with the conversion of projects to VB.NET.
  • The VB Documentation Tool can assist with code reviews and source code audits.
  • In this competitive market, why not produce project documentation for your clients? This shows you treat project documentation seriously.
  • When making large scale changes to a project, use it to find out where a function or a subroutine is called from.
  • Document your existing projects to assist with future code reuse.
  • Don't let your new hires loose on a project without them having the VB Documentation Tool's reports to help them on their way!
  • Use it to easily print colour coded and syntax highlighted copies of source code.
  • The HTML Help format report is fully searchable - this includes the source code as well.
  • The HTML format documentation can be easily incorporated into a company Intranet or Extranet.
  • Include an VB Documentation Tool™ report of an old VB application you have archived, so if you need to go back to it you'll know where to find things.