I am looking for a good tool creating HTML / Help files from my VS2010 XML documentation. I have found some commercial tools, such as
- .Net documentation tool
- VSDocman
I am sure there are more, I just list these two as examples. Also there are simple XSLT stylesheets around to convert the XML to HTML documentation.
What are you using, e.g. is there a free tool to do the conversion, maybe as Add-In. Just to clarify, basically I have found two types of tools:
- The ones converting the XML documentation file in different target formats, this is what I am looking for.
- Tools helping me to generate the XML documentation in the source code. This is not(!) what I am looking for.
Thanks for your help.
The Sandcastle / SHFB combo works great. Thanks to all who helped.
Some remarks:
- NDoc seems to be outdated, last updates are from 2005. That's why I have skipped this.
- A similar thread, also very detailed, can be found here: How to turn C# Xml Doc-Comments into something useful? Thanks for the hint!
- There are some sources for Sandcastle, the latest version I have found is located here: http://sandcastle.codeplex.com/
- In order to generate
MsHelp2
I had to install VS 2008 SDK containinghscomp.exe
. There is a version 1.0 and 1.1, as far as I could figure it out version 1.0 contains the compiler. See Helixsoft and Social MSDN for some details. - In my case the generated WebHelp does not work correctly with Chrome. It always reloads the index.html page.
- The topic here shows how to add namespace infos into sandcastle documentation.
- Update as of Nov 2012: For smaller projects I am using Doxygen - I find it a little easier to configure.