VBDOX - Visual Basic Documentation Generator

Overview
Features
Screenshots
Download
     Languages
     Reports
Demo
How to
Developer
License
Other tools
Contact
Q & A

Google
Web sourceforge.net

VBDOX - Visual Basic Documentation Generator

Note: For up-to-date information see the VBDOX Document Manager on sourceforge.net

Java style documentation comments

Java style documentation comments are wide known so just an example will be shown.

White space policy is not restrictive :). You can format your comments as you want. You can also put HTML markup within the comments.

  1. Module (Module, Class, UserControl) level comment
    ''
    ' Module description.
    ' Can be more than one line.
    ' 
    ' @remarks Put your remarks on the module implementation here
    ' @author michael.stamenov@web.de
    ' @version 0.0.20
    ' @date 20010826
    As you can see there are two extention tags: remarks and date. The last one is not in the reports at the moment.
  2. Method (Sub, Function, Property, Event, variables and constants) level comment
    Example
    ''
    ' Sets the country code for the user
    '
    ' @param ud	Specifies reference to user
    ' @param intNewValue Specifies new country phone code
    ' @return 	The previous country code of the User
    ' @remarks This value is not used by Windows® 2000
    
    Public Function countryCode(ud As Variant, ByVal intNewValue As Integer) As Integer
  3. Enumerators and user defined types (Enum and type)
    Example
    ''
    ' Four seasons
    '
    ' @param spring	Something about the spring
    ' @param summer	Something about the summer
    ' @param autumn	Something about the autumn
    ' @param winter	Something about the winter
    
    Public Enum seasons
    	spring
    	summer
    	autumn
    	winter
    End Enum
    
  4. Interfaces (Implements)
    Example
    ''
    ' My report manager implements the interface needed by VBDOX.
    '
    
    Implements IReportManager
    
Since version 1.0.34 see attribute is supported for referencing types (classes, types and enumeartors). For example
 @see Project1.Class1
 @see Class1
 @see Enum1
 



SourceForge Logo

Spanish by Maria Ramos from Webhostinghub.com/support/edu