We are glad to announce that the new VSdocman 12.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 several new features and fixes some issues. You can download it from here.
What's new in VSdocman version 12.0:
- NEW: Added support for projects that target .NET 6 and later. VSdocman worked with such projects even before, but only partially. For example, cref links to .NET types were not resolved.
- NEW: Added support for C# global using directive. The global using and implicit global using directives were introduced in C#10 (with .NET6, but may be used with .NET Framework as well).
- NEW: Added new output formats html_2025 and chm_2025. These are continuations of the older html_msdn2019 and chm_msdn2019, and it is recommended to switch to the new ones. Several improvements were implemented in the new templates, such as better responsiveness. The HTML output is more mobile-friendly now.
- NEW: Added new Markdown output format which uses Github-flavored Markdown syntax. It is a simple text format which can be easily converted to HTML, PDF or other formats. It is suitable for version control systems like Git. You can use any Markdown editor to edit the files. The final documentation can be viewed in any Markdown viewer or converted to other formats. The main page is "index.md". It's especially suitable for Github wiki or pages. The table of contents is generated in "_Sidebar.md" file which is recognized by Github wiki. See an example.
- NEW: Added support for Greek characters in CHM output. You just need to select the "el-GR" language in the output format options.
- FIX: The comment editor and "Add XML comment" didn't work with shared projects (.shproj).
- FIX: Dead links were reported when the documentation was generated, if there were "using" statements in C# (or "Imports" in VB) with an alias. For example, using Point = System.Drawing.Point. Then the links starting with the alias would fail with the warning, for example, <see cref="Point3D">.
- FIX: When an <inheritdoc> or <include> XML doc tags imported multiple XML elements, they were inserted in the reverse order. This was not a problem if the imported elements were top-level elements, such as <summary>, <remarks> and others, because their order is not important. But if the imported elements were, for example, <para> tags inside a <remarsks>, they were in the wrong order in the generated documentation.
- FIX: When compiling documentation from command line with VSdocmanCmdLine.exe using VS 2017, a "Could not load file or assembly EnvDTE" exception could occur.
- FIX: The html_msdn2019 and chm_msdn2019 output didn't work correctly if there was an <svg> element injected in the documentation. An SVG element can be added in the header, footer or any other part of the page, see "Using HTML and Unknown Tags in XML Comments" topic in the help.
- FIX: An unhandled exception message could be displayed if the user moved the mouse cursor out of the comment editor. This was harmless but annoying.