VSdocman 9.0 released - with VS 2019 support
- 24 Apr 2019 12:00
We are glad to announce that the new VSdocman 9.0 has been released. VSdocman is a Visual Studio tool for a quick commenting and automatic generation of technical documentation from your C# and VB .NET source code files. For more information go to VSdocman home page .
This major update adds support for VS 2019, new features and fixes some problems. You can download it from here.
What's new in VSdocman version 9.0:
- NEW: Added support for Visual Studio 2019.
- NEW: Added new html_msdn2019 output format. It has modern look and frameless layout.
- NEW: It's possible to use HTML code directly in XML doc comments. You can use any HTML tag, such as <span id="5" style="font-size: 50px;">, <div class="abc">, etc. These elements, that are unknown to VSdocman as XML doc elements, will be passed to HTML-based output (HTML, CHM, MS Help Viewer). In other outputs, such as Docx, these unknown tags will be stripped and only their content will be displayed as a plain text. Note that the HTML tags cannot be edited in the WYSIWYG comment editor, you need to insert them manually in the source comment. But the editor will display them and it will not remove them once they are present.
- NEW: VSdocman has a new menu. It's a top level menu in VS 2017 and lower. In VS 2019, the menu is under EXTENSIONS top menu. Previously, there was only a menu entry under TOOLS menu. Now you can also directly compile your documentation or edit comments, if possible.
- NEW: You can customize your HTML-based output (HTML, CHM, MS Help Viewer) more easily, without the need of modifying the output templates. Just put a file named "vsdocman_overrides.css" in your External files folder and VSdocman will automatically link it to all HTML pages. You can define your own styles or override the existing ones in that CSS file. For more details see the manual in "Using VSdocman > Tips & Tricks > Customizing HTML Output" topic.
- CHANGE: Removed support for VS 2012. Only VS 2019, 2017, 2015 and 2013 are supported now.
- CHANGE: Greatly improved the launch speed of the comment editor and partially also of the main VSdocman window, when they are opened for large solutions and projects.
- FIX: If a source code file is read only (e.g. in a run mode), it's no longer possible to open the comment editor. If a modeless comment editor is already open, it's not possible to make any changes in it. This is to prevent from loosing your changes that couldn't be written back to the file.
- FIX: When an XML comment was missing at a method with parameters or at a property, it was not automatically extracted from an implemented interface. Only VSdocman 8.5 and 8.6 were affected.
- FIX: Compilation from command line with VSdocmanCmdLine.exe sometimes failed for .NET Standard and .NET Core projects. No topics were generated in the documentation.
- FIX: Inserting an XML comment with the comment editor or from the "Add XML comment" menu has triggered reformatting of the commented code element, even if the auto-formatting was turned off in the VS options.
- FIX: In Docx and PDF outputs, if the "Constants and enumerations value display" option was set to "No value", the values were still displayed for enum items that had no explicit value set.
- FIX: An error occurred when processing a class diagram in some rare cases.