Generate XML Documentation

Top  Previous  Next

 VS   VB6   VB5   VBA 

The Generate XML Documentation feature allows you to generate a file with documentation of your source code in XML format. The XML file includes elements such as references, projects, files, methods, parameters, controls, etc. Each element includes subelements with relevant properties.

The XML file includes also comment line elements for code elements, whose content is extracted from the source code (provided you have entered them). Comments are extracted line by line as literals, so you can use any format for them, that is, they do not need to be XML-compliant.

You can customize the encoding (Default, Unicode, etc.) of the output XML file in the Options window, Team Options tab, XML Documentation section. You can also specify the name of an executable file that can be used for further processing, if required.

MZ-Tools offers the following ways to generate XML documentation:

  • The MZ-Tools | Other Utilities | Generate XML Documentation... menu.
     
  • The Generate XML Documentation button on the MZ-Tools - Other Utilities toolbar.
     
  • In Visual Studio, the keyboard shortcut associated with the MZTools8.GenerateXMLDocumentation command.
     
  • In VB6 / VB5 / VBA, the keyboard shortcut associated with the Generate XML Documentation feature.
     
  • In VB6 / VB5 / VBA, the Generate XML Documentation... menu entry on the context menu of a project in the Project Explorer.

When you invoke this feature, a window is shown that allows you to select the scope of the operation and the name of XML file:

GenerateXMLDocumentation

Remarks:

  • Ensure that the source code can be compiled without errors before running this feature.

See Also:

XML Documentation Options

Generate HTML Documentation

Keyboard Shortcuts Options