VSDocman 8.5.2 for VS2012-2017
VSDocman 8.5.2 for VS2012-2017
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
Productivity
Integration with Visual StudioEverything 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
VS 2010 documentationCreate 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.
Automatic commenting
Automatic insertion of XML commentsLet 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.
Comment editor
Editor for XML documentation commentsMake your XML comments better. Use the WYSIWYG comment editor to insert tables, lists, pictures, links and other formatting directly in your XML doc comments.
Class diagrams
Class diagramAdd clickable class diagrams anywhere in your documentation.
Complete authoring solution
Custom topics in generated documentationCreate 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.
Simple deployment
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.
Version 8.5.2
(8 Jul 2018)
FIX: After editing a method with parameters in the WYSIWYG comment editor, there was the "{additionalAttributes}" text included in the generated comment tag. The issue was introduced in version 8.5.
Version 8.5
(25 Jun 2018)
NEW: Added new XML comment tag. In addition to the automatic comment inheritance, this tag will allow you to control the inheritance of XML comments more precisely. For example, you can inherit only some parts of the comment or override some tags in it.
NEW: Added three new macros that you can use in the project properties to specify the output path, templates path and external files path. The new macros are: $(ProjectName), $(SolutionName) and $(ProfileName).
NEW: Added the option to disable listing of extension methods on Members page. This option is on Code Members - Member Types options page.
NEW: Allowed also VB variants as values of the langword attribute in the tag, such as Nothing, True, False, Shared, MustInherit, NotInheritable, Overridable. Moreover, you can use any text as a langword and it will be displayed and not ignored as before.
NEW: In the comment editor, a tooltip with details is displayed when you hover over a link or a langword, such as 'null'.
IMPROVEMENT: Significantly improved the startup speed of the comment editor when it's launched for the first time in the session. This applies to most but not all cases. When you open the editor for the first time in the session for a particular project, it is almost instant if it's done for a member with an existing XML comment. If there is no comment and the "Try inherit" option is enabled in the comment templates, then there's still a delay for the first time. It's because VSdocman tries to inherit the comment from types from referenced external DLLs, which may take some time if there are many references in the project. All successive openings or updates of the editor should be instant.
CHANGE: It's now possible to use incomplete type names or language specific type names (e.g. int) as parameters in links. Previously you needed to specify fully qualified type names or omit the parameters. Now you can use .
CHANGE: The WYSIWYG comment editor no longer removes custom inline XML tags that are not supported by VSdocman. For example, you can have a text some text inside your block and it will be kept untouched by the editor. This is especially useful for tags that may have be nested inside top level blocks, such as or . Similarly, the editor will keep custom attributes in supported XML tags, for example .
FIX: Generation of a PDF documentation failed for the "Compile Solution to Single Documentation" operation.
FIX: If the cursor was placed on a field, a constant or a single line property, that had some trailing comment (e.g. 'int Field1; //comment'), adding an XML comment or opening the comment editor was done for the parent class instead for the field.
FIX: It was possible to select "Try to inherit from overridden member" in the comment template for constructors. This option was ignored and the comments for constructors were never inherited. So the option is removed now. It is still possible to inherit constructor comment with comment tag.
FIX: The generated text for a self-closed link was incorrect, if the link pointed to an external method with arguments specified with full names, i.e. with dots in them. For example, was displayed as "String)" instead of "CompareTo(System.String)".
(8 Jul 2018)
FIX: After editing a method with parameters in the WYSIWYG comment editor, there was the "{additionalAttributes}" text included in the generated comment tag. The issue was introduced in version 8.5.
Version 8.5
(25 Jun 2018)
NEW: Added new XML comment tag. In addition to the automatic comment inheritance, this tag will allow you to control the inheritance of XML comments more precisely. For example, you can inherit only some parts of the comment or override some tags in it.
NEW: Added three new macros that you can use in the project properties to specify the output path, templates path and external files path. The new macros are: $(ProjectName), $(SolutionName) and $(ProfileName).
NEW: Added the option to disable listing of extension methods on Members page. This option is on Code Members - Member Types options page.
NEW: Allowed also VB variants as values of the langword attribute in the tag, such as Nothing, True, False, Shared, MustInherit, NotInheritable, Overridable. Moreover, you can use any text as a langword and it will be displayed and not ignored as before.
NEW: In the comment editor, a tooltip with details is displayed when you hover over a link or a langword, such as 'null'.
IMPROVEMENT: Significantly improved the startup speed of the comment editor when it's launched for the first time in the session. This applies to most but not all cases. When you open the editor for the first time in the session for a particular project, it is almost instant if it's done for a member with an existing XML comment. If there is no comment and the "Try inherit" option is enabled in the comment templates, then there's still a delay for the first time. It's because VSdocman tries to inherit the comment from types from referenced external DLLs, which may take some time if there are many references in the project. All successive openings or updates of the editor should be instant.
CHANGE: It's now possible to use incomplete type names or language specific type names (e.g. int) as parameters in links. Previously you needed to specify fully qualified type names or omit the parameters. Now you can use .
CHANGE: The WYSIWYG comment editor no longer removes custom inline XML tags that are not supported by VSdocman. For example, you can have a text some text inside your
FIX: Generation of a PDF documentation failed for the "Compile Solution to Single Documentation" operation.
FIX: If the cursor was placed on a field, a constant or a single line property, that had some trailing comment (e.g. 'int Field1; //comment'), adding an XML comment or opening the comment editor was done for the parent class instead for the field.
FIX: It was possible to select "Try to inherit from overridden member" in the comment template for constructors. This option was ignored and the comments for constructors were never inherited. So the option is removed now. It is still possible to inherit constructor comment with comment tag.
FIX: The generated text for a self-closed link was incorrect, if the link pointed to an external method with arguments specified with full names, i.e. with dots in them. For example, was displayed as "String)" instead of "CompareTo(System.String)".
Only for V.I.P Warning! You are not allowed to view this text.