VSdocman v9.6 - Visual Studio documentation generator and .NET code Commenter
VSdocman v9.6 - 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
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 9.6
FIX: In the generated list of class constructors, there were listed also the constructors from the base classes. This was wrong because constructors cannot be inherited.
FIX: Some inherited methods and properties were listed in the generated Methods or Properties lists even if the 'List inherited members on "Class members" page' option was deselected. The problem applied only to the inherited members that were defined in the solution. External inherited members were not listed, e.g. ToString() method from Object class.
FIX: If you created a new solution profile with VSdocman profile manager as a copy of another profile, the solution-wide properties were not copied. The default properties were applied instead.
FIX: Wrong formatting after pasting parts of ordered or bulleted lists in the WYSIWYG comment editor. If only some items of a list were copied in the clipboard, then they were incorrectly rendered if they were pasted in the edited text that was not a list.
FIX: A linebreak entered with Shift+Enter was displayed as an unknown
XML doc tag with the blue highlighting when it was reopened in the WYSIWYG comment editor. Now there's a correct new line displayed.
FIX: Improved pasting of a source code to a code section in the WYSIWYG comment editor. For example, if a source code sample was pasted, e.g. from VS editor, empty lines were removed. Or when lines from one code section were copied to another one, the linebreaks were lost.
FIX: In some cases, a dead link could be generated for or links containing methods with specified parameters. This happened in two cases. The first one was, if there existed a method or a property with the same name as the parameter type of the referenced method. For example, the link was and there was also a method like the following one defined in the same class: void Action(). The second case was, if the referenced method was in another class than the comment with the link and the link was not in a full format, i.e. including the namespace.
FIX: In Visual Basic code, a dead link was generated for links containing the names inside square brackets. This syntax is used in VB for symbols that are same as the VB reserved words, such as Enum, ByVal, etc. For example, there was a method defined as follows: Sub [Enum](x As [Enum]). The corresponding link could be: . Such links are processed correctly now.
FIX: In the generated list of class constructors, there were listed also the constructors from the base classes. This was wrong because constructors cannot be inherited.
FIX: Some inherited methods and properties were listed in the generated Methods or Properties lists even if the 'List inherited members on "Class members" page' option was deselected. The problem applied only to the inherited members that were defined in the solution. External inherited members were not listed, e.g. ToString() method from Object class.
FIX: If you created a new solution profile with VSdocman profile manager as a copy of another profile, the solution-wide properties were not copied. The default properties were applied instead.
FIX: Wrong formatting after pasting parts of ordered or bulleted lists in the WYSIWYG comment editor. If only some items of a list were copied in the clipboard, then they were incorrectly rendered if they were pasted in the edited text that was not a list.
FIX: A linebreak entered with Shift+Enter was displayed as an unknown
XML doc tag with the blue highlighting when it was reopened in the WYSIWYG comment editor. Now there's a correct new line displayed.
FIX: Improved pasting of a source code to a code section in the WYSIWYG comment editor. For example, if a source code sample was pasted, e.g. from VS editor, empty lines were removed. Or when lines from one code section were copied to another one, the linebreaks were lost.
FIX: In some cases, a dead link could be generated for or links containing methods with specified parameters. This happened in two cases. The first one was, if there existed a method or a property with the same name as the parameter type of the referenced method. For example, the link was and there was also a method like the following one defined in the same class: void Action(). The second case was, if the referenced method was in another class than the comment with the link and the link was not in a full format, i.e. including the namespace.
FIX: In Visual Basic code, a dead link was generated for links containing the names inside square brackets. This syntax is used in VB for symbols that are same as the VB reserved words, such as Enum, ByVal, etc. For example, there was a method defined as follows: Sub [Enum](x As [Enum]). The corresponding link could be: . Such links are processed correctly now.
Only for V.I.P Warning! You are not allowed to view this text.