Generate API documentation for your C# and VB .NET code
VSdocman – Visual Studio documentation generator and .NET code commenter
VSdocman is an ultimate, fast and easy to use .NET documenting tool for every Visual Studio C# and VB developer.
- Document your .NET code on a professional level.
- Generate comprehensive MSDN-style class documentation for your C# and Visual Basic .NET projects, with custom topics, IntelliSense and F1 context sensitive help.
- See how easy the code commenting with XML doc comments can be with powerful comment templates and sophisticated WYSIWYG comment editor.
VSdocman – a .NET documentation compiler – is directly integrated in Visual Studio so it will assist you with complete process of creating a documentation. This includes intelligent semi-automatic commenting of your code elements, creating additional topics (non-API reference) and generating and deploying the documentation.
Based on your settings, VSdocman scans a VS project or a solution, and then it generates the final documentation. It automatically reads namespaces, types and their members. Summary, remarks, parameter descriptions and other content are extracted from XML documentation comments in your code (those that start with /// or ”’). The tool will boost your productivity no matter whether you create a class library, a component, a control, an application, a web site (ASP .NET) or any other C#/VB project type.
Move your documenting to the next level
Everything directly in Visual Studio. Save your time, effort and money. With VSdocman, you can generate documentation from the .NET XML comments with just a single mouse click.
Flexible output formats
Create professional technical documentation in multiple and localizable formats – HTML, CHM, Microsoft Help Viewer (VS 2013/2012/2010 help), MS Help 2 (VS 2002 – 2008 help), Docx (OOXML format used in MS Word), PDF, XML and others.
Let VSdocman automatically comment your code. Don’t author the XML comments and common phrases manually. Intelligent comment templates make it significantly easier to write comments.
Make your XML comments better. Use the WYSIWYG comment editor to insert tables, lists, pictures, links and other formatting directly in your XML doc comments.
Add clickable class diagrams anywhere in your documentation.
Complete authoring solution
Create a complete end-user manual with your own topics, such as overview, examples, license agreement, usage descriptions, etc.
VS help integration
Fully integrate generated help into Visual Studio help system including IntelliSense and F1 context sensitive help. Your assemblies will look like a part of the .NET framework.
Easily deploy and register the documentation on target computers. No more troubles during installation.
Command line mode
Generate documentation in a command line mode during your automated builds.
Learn more about VSdocman features.
What you get with VSdocman:
- All in one solution. You can create complex comments, generate VS documentation and then deploy and register it. Everything directly from Visual Studio.
- Professional documentation of your code can be created in seconds for your customers, clients, you and your co-developers.
- Consistency. All changes in the code are automatically reflected in newly generated documentation, which is always up to date and accurate.
- Documentation in various formats and languages can be produced with just a few mouse clicks.
- Efficient communication within a team, especially when a source control is used (e.g. TFS, Subversion, GIT or SourceSafe). Each developer comments his part of code. Everybody in the team can then see the comments, get an on-line help and use IntelliSense tooltips to easily understand the code.
- The source code is precisely commented and looks professional.
VSdocman works as an extension for:
- Visual Studio 2017 – all editions except for Express edition
- Visual Studio 2015 – all editions except for Express edition
- Visual Studio 2013 – all editions except for Express edition
- Visual Studio 2012 – all editions except for Express edition
VSdocman requires .NET framework 4.5 or higher (it is installed with VS 2012 or higher).
Documented projects may target any .NET framework, including 1.0, 1.1, 2.0, 3.0, 3.5, 4.0, 4.5 and 4.6.
VSdocman is a Visual Studio code commenter and documentation generator. Here is a list of its features.
- Supports C# and VB .NET in any type of project, including class library, application, web app, Android, cross-platform, WPF, WCF, Silverlight, etc.
- Works with Visual Studio 2017 / 2015 / 2013 / 2012.
- Supports projects that target any .NET framework: 1.0, 1.1, 2.0, 3.0, 3.5, 4.0, 4.5 and 4.6.
- Full support for generics, extension methods, dependency properties and attached properties and other .NET features.
- Works in GUI and command line modes.
- No need for compiled assemblies. Everything is extracted directly from the source code. This is especially useful for web projects.
- You can select which members will be documented using filtering by type, accessibility, project file, name and attributes.
- You can add your own non-API topics such as overview, examples, license agreement, usage descriptions, etc.
- Profiles for settings.
- Conditional compilation. You can define conditional constants and add condition to the member comment. This way you can include or exclude specific members from documentation.
- Generates the following documentation formats:
- CHM (HTML Help 1.x) – CHM file suitable for general purpose help.
- HTML – files with index, search and a table of contents. Works even locally without a web server.
- Docx – OOXML format used in MS Word.
- PDF document suitable for printing.
- Microsoft Help Viewer 2.x and 1.x – Microsoft help technology used in Visual Studio 2015, 2013, 2012 and 2010 and MSDN; .mshc file. Suitable for integration with VS help or MSDN.
- MS Help 2 – Microsoft help technology used in Visual Studio .NET and MSDN versions 2002 – 2008, .HxS file. Suitable for integration with VS help or MSDN.
- XML which can be processed later by other tools.
- Others. User is allowed to define his own format for any text based document such as LATEX, custom HTML and others.
- Each output format is highly customizable so you can easily apply your corporate style.
- Generates IntelliSense (auto-completion tooltips) and Object Browser info.
- Creates F1 help.
- Integrates in VS help system on a target computer.
- Easily deploys Visual Studio documentation to target computers using accompanied royalty-free command-line utilities.
- Output is localizable. There are several built-in languages including English, German, French, Spanish, Portuguese, Hebrew and others.
- Creates links to framework classes, even in HTML and CHM output.
- Documentation can contain source code of a code member.
- Supports standard XML doc comments.
- Using fully customizable templates, you can automatically insert predefined texts in comments, e.g. “Initializes a new instance of the class” for constructors.
- Contains sophisticated WYSIWYG comment editor that you use directly in Visual Studio.
- You can automatically insert default XML comment to a member.
- You can automatically insert Description attribute to your property. This is used for property short description in Properties Window.
- You can insert tables, lists, pictures, class diagrams, links, colors, bold, italics and other formatting directly in your source code.
- Supported XML comment tags.
Installation/Activation Instruction is Included in the folder!