Latest News

We are glad to announce that the new VSdocman 10.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 brings several new features mainly related to the WYSIWYG comment editor and fixes some little problems. You can download it from here.

What's new in VSdocman version 10.0:

1. NEW: The WYSIWYG comment editor is now available also for external XML doc files that are included with <include> XML doc tag. It is available from the comment editor, Advanced tab. There's new "Editor" button in the include section.
2. NEW: The option to always open VSdocman window with SOLUTION-WIDE PROPERTIES instead of the project that is active in Visual Studio. It's in VSdocman Options > Miscellanous > General.
3. CHANGE: XML comments, such as <summary><!-- this is comment --></summary> inside XML doc comments are allowed now. Unlike before, they are not outputted in the generated documentation now. The WYSIWYG comment editor will preserve such XML comments too.
4. CHANGE: The comment editor will generate &#160; entity for a non-breaking space. This is to easily distinguish it from a normal space.
5. CHANGE: The comment editor will no longer generate &quot; and &apos; entities for " and ' characters in XML text. Such escaping is needed only in XML attributes and not doing it in the text will make XML comments more readable.
6. CHANGE: The comment editor did not open if the active document was under source control (TFS) and was not checked out. The editor will now check out automatically, if the "Check out automatically" when editing is selected in VS source control options.
7. CHANGE: When the user inserts a table or a code block in the comment editor, an empty paragraph is added before and after it if needed, to ensure that it's possible to enter text there.
8. CHANGE: Links to enum items, such as <see cref="MyEnum.Value1"/>, are no longer generated as non-link bold text. The link to the owner enum is generated now.
9. CHANGE: The values of enum fields are now displayed in generated html_msdn2019 and chm_msdn2019 output formats.
10. FIX: If a type, e.g. a class, was excluded because it had no XML comment and "Compile also non-commented members" option was not selected, its members such as methods and properties were still included in the documentation. They were not available in the contents tree, but they could be visible in search results.
11. FIX: The errors in external XML doc files were not reported during compilation. Such external XML files are included with <include> XML doc tags and they can cause various problems - IO error, invalid XML syntax, etc.
12. FIX: XML errors in custom topics were not reported during compilation. This could happen if the user edited the XML source of the topics directly instead of in the WYSIWYG editor.
13. FIX: "Dead link" warnings in custom topics were not reported during compilation.
14. FIX: In custom topics (not in code members), the links to methods with parameters were not generated correctly in the final documentation, for example <see cref="Ns1.Class1.Method1(Ns1.Class1)"/>.
15. FIX: "Dead link" warnings occurred for incomplete links to generic methods with parameters excluded. For example, <see cref="Ns1.Class1.Method1{T}"/>.
16. FIX: Visual Basic properties, that had no explicit access modifier (Public, Private, ....) and were not auto-implemented (had Get and Set parts), were not included in the generated documentation.
17. FIX: Whitespaces between inline tags in XML doc comments were removed in the WYSIWYG comment editor and in the comments coming from external XML files included with <include> tag. For example, the space between A and B in: <summary><b>A</b> <u>B</u><.summary>.
18. FIX: The WYSIWYG comment editor added an extra space character after a <br/> tag.
19. FIX: When the user added an exception or a permission in the WYSIWYG comment editor, it was not possible to edit the text in it and the <exception> or <permission> tag was not inserted in the generated XML comment.
20. FIX: An extra empty <see> tag could be added after editing an existing link in the WYSIWYG comment editor.
21. FIX: When the user clicked on a link in the WYSIWYG comment editor, the page was scrolled down to the end of the editable section in some cases.
22. FIX: Some combinations of special XML characters in XML comments could produce wrong result in the generated documentation. For example, <summary>&amp;lt;</summary> would produce "<" instead of "&lt;".