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.
What's new in VSdocman version 7.3:
- NEW: Added complete traditional Chinese translation for generated documentation. Just select zh-TW as the language in the output options.
- NEW: You can specify topics version for the MS Help Viewer format. See VSdocman's help, Viewing and Deploying Documentation - View and Deploy MS Help Viewer Documentation - Topic Versions in MS Help Viewer Documentation page.
- CHANGE: In web site projects without a project file (not web applications), the $(ProjectDir) macro in the output options has a different value. Previously it was the directory constructed from <SOLUTION_FOLDER>\<WEBSITE_NAME>. Now it points just to <SOLUTION_FOLDER>. So if you have a web site (not a web application with a project file) and you specified the Output folder as $(ProjectDir)VSdoc, you need to change it to $(ProjectDir)<WEBSITE_NAME>\VSdoc, where <WEBSITE_NAME> is the name of your web site project.
- FIX: The links that contained an ampersand (e.g. <see href="http://www.helixoft.com/index?x=1&y=2"/>) were generated incorrectly.
- FIX: The link to the parent namespace was not generated in a code member topic, if the namespace was a root namespace in the project.
- FIX: In VB .NET, external methods defined with DllImport attribute instead of Declare statement were not recognized as external.
- FIX: Links to external methods (defined with DllImport attribute) were not generated correctly.
- FIX: If an event in VB .NET was defined with an explicit generic delegate, e.g. Public Event TextChanged As EventHandler(Of TextChangedEventArgs), the syntax section in documentation was generated incorrectly.
- FIX: If a method in a class implemented a method in an interface, the comment for a method was incorrectly inherited if the interface contained multiple method overloads, i.e. methods with the same name but different parameters. This happened when you for example clicked "Add XML comment" for the method in the class.
- FIX: The blank lines inside a <code> tag that were inserted in the comment editor were not included in the XML comment.