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

VBDOX - Visual Basic Documentation Generator

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

XML documentation comments

These comments are not parsed in versions before 1.1.xx. They were intended for use with the XML report generator. You can create your own comment structure within the comment. This allows you to transform (XSLT) the generated XML.

The '<comment>' tag and the comment symbol (') must be as shown. No spaces are allowed.

The new (version 1.1.xx and later) XML comment parser can handle comments in the form shown in the examples below. This style is close to the proposed by Microsoft in .NET.

Example

'<comment>
' <summary>Test class module</summary>
' <author>ms</author>
' <version>1.0.0</version>
'</comment>

'<comment>
' <summary>Sets the country code for the user</summary>
' <param name="ud">
' Specifies reference to user </param>
' <param name="intNewValue">
' Specifies new country phone code</param>
' <return>
' The previous country code of the User</return>
'</comment>


Public Function countryCode(ud As Variant, ByVal intNewValue As Integer) As Integer

Note: If you want to include HTML formating in the comments you must use entities (<, >, &, " and '). Only the listed entries are expanded at the moment. You can not use entitie as  .