VSdocman allows commenting and the automatic generation of technical documentation from 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# source code files.

VSdocman parses the Visual Studio

Microsoft Visual Studio

Microsoft Visual Studio is an integrated development environment from Microsoft. It is used to develop console and graphical user interface applications along with Windows Forms applications, web sites, web applications, and web services in both native code together with managed code for all...

 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...

, API and custom topics, cross-references, IntelliSense

IntelliSense

IntelliSense is Microsoft's implementation of autocompletion, best known for its use in the Microsoft Visual Studio integrated development environment...

 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 XML 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...

. VSdocman contains WYSIWYG

WYSIWYG

WYSIWYG is an acronym for What You See Is What You Get. The term is used in computing to describe a system in which content displayed onscreen during editing appears in a form closely corresponding to its appearance when printed or displayed as a finished product...

 comment editor which helps writing XML comments. It is possible to insert tables, lists, 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:...

, Microsoft Help Viewer, Microsoft Help 2

Microsoft Help 2

Microsoft Help 2.x is a proprietary format for online help files, developed by Microsoft and first released in 2001 as a help system for Visual Studio .NET and MSDN Library....

, 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....

.

History

Originally, VSdocman was named VBdocman .NET because it evolved from VBdocman

VBdocman

VBdocman allows commenting and the automatic generation of technical documentation from Visual Basic 6 source code files.VBdocman parses the Visual Basic projects and automatically creates the table of contents, index, topics, cross-references and F1 context-sensitive help.It can read Javadoc...

. VBdocman .NET only supported Visual Basic .NET. It was renamed to VSdocman after adding support for C#.

External links

• webpage