|
Description:
VBDoc helps you document Visual Basic projects. Specify the existing
vbp file and it will study the code, identifying all the Forms, Modules,
Class Modules in the project and all the functions, procedures, properties
and events defined in them. VBDoc can create a set of well-linked HTML
files that contains the complete documentation of your project and/or
can insert comments in the source code.
Version 2.0 extends the features of the previous one. The
following are the new features of version 2.0:
- A better GUI with a wizard-like interface to guide you through the
utility.
- The HTML files generated are better linked, providing for a better
navigation. Each file contains a summary of all the functions/procedures
defined within.
- Version 2.0 has the ability to insert comment headers in the code.
This header is completely customizable and will help a lot in code study.
VBDoc is inspired from JavaDoc (the documentation utility
that comes bundled with JDK). Needless to say then that VBDoc can
create a set of well-linked HTML files that contains the complete documentation
of your project. VBDoc is different from JavaDoc in several ways:
- JavaDoc requires you to follow certain commenting standards.
VBDoc does not pose any such limitation. So, you can run VBDoc
even on older existing projects.
- VBDoc (unlike JavaDoc) can help you trace the logical
flow of your project. Within every function/procedure it identifies,
VBDoc tries to find out all the user-defined functions called.
It then provides a hyperlink in the documentation to the definition
of those functions. This will be very useful in studying existing
code.
- VBDoc can insert comment headers in the code - something
that makes it very easy for a third person to read and understand
your code.
Click here
to see sample documentation created by VBDoc.
|