VBdocman allows commenting and the automatic generation of technical documentation from Visual Basic 6

Visual Basic

Visual Basic is the third-generation event-driven programming language and integrated development environment from Microsoft for its COM programming model...

 source code files.

VBdocman parses the Visual Basic projects and automatically creates the table of contents

Table of contents

A table of contents, usually headed simply "Contents" and abbreviated informally as TOC, is a list of the parts of a book or document organized in the order in which the parts appear...

, index

Index (publishing)

An index is a list of words or phrases and associated pointers to where useful material relating to that heading can be found in a document...

, topics, cross-references and F1 context-sensitive help

Context-sensitive help

Context-sensitive help is a kind of online help that is obtained from a specific point in the state of the software, providing help for the situation that is associated with that state....

.

It can read Javadoc

Javadoc

Javadoc is a documentation generator from Sun Microsystems for generating API documentation in HTML format from Java source code.The "doc comments" format used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs, such as Netbeans and Eclipse automatically generate...

 comments from the source code

Source code

In computer science, source code is text written using the format and syntax of the programming language that it is being written in. Such a language is specially designed to facilitate the work of computer programmers, who specify the actions to be performed by a computer mostly by writing source...

. VBdocman contains comment editor which helps writing comments. It is possible to insert pictures, links and other formatting directly into the source code.

The format of output documentation

Documentation

Documentation is a term used in several different ways. Generally, documentation refers to the process of providing evidence.Modules of Documentation are Helpful...

 is configurable. Predefined formats are HTML Help

Microsoft Compressed HTML Help

Microsoft Compiled HTML Help is a Microsoft proprietary online help format. It was introduced as the successor to Microsoft WinHelp with the release of Windows 98, and is still supported in Windows 7.-History:...

, WinHelp

WinHelp

Microsoft WinHelp is a proprietary format for online help files that can be displayed by the Microsoft Help browser winhelp.exe or winhlp32.exe. The file format is based on Rich Text Format . It remained a popular Help platform from Windows 3.0 platform through Windows XP...

, HTML

HTML

HyperText Markup Language is the predominant markup language for web pages. HTML elements are the basic building-blocks of webpages....

, RTF

Rich Text Format

The Rich Text Format is a proprietary document file format with published specification developed by Microsoft Corporation since 1987 for Microsoft products and for cross-platform document interchange....

 and XML

XML

Extensible Markup Language is a set of rules for encoding documents in machine-readable form. It is defined in the XML 1.0 Specification produced by the W3C, and several other related specifications, all gratis open standards....

.

VBdocman has its successor VSdocman

VSdocman

VSdocman allows commenting and the automatic generation of technical documentation from VB .NET and C# source code files.VSdocman parses the Visual Studio projects and automatically creates the table of contents, index, API and custom topics, cross-references, IntelliSense and F1 context-sensitive...

 which supports VB .NET

Visual Basic .NET

Visual Basic .NET , is an object-oriented computer programming language that can be viewed as an evolution of the classic Visual Basic , which is implemented on the .NET Framework...

 and C#.

External links

• webpage