How to format Visual Studio XML documentation for display on the Internet

Question

I use Visual Studio 2010 and became a good boy and have documented all my code when I write it using XML comments. I have a well-documented project, and I even figured out how to get Visual Studio to spit out a complete XML document when building. My question is, what is the best way to format / display this document on the Internet so that it displays in a convenient friendly and convenient format like MSDN? Is there a tool that makes this easy?

Thanks in advance!

Answer 1

Give up on Sandbule Help File Builder . This is a GUI tool that simplifies Sandcastle. It will be installed in the folder in the "Start" menu → "Program Files" → "File Builder" in Sandcastle; It is quite easy to use, but it is not incredibly fast.

Hope this helps!

Answer 2

Check out Sandcastle .

Sandcastle produces the exact MSDN style, complete documentation reflecting the source builds, and possibly the integration of XML documentation comments.

Wikipedia contains additional information and links to additional projects that integrate with sandcastle.

---

Another option (which looks a lot easier to use): docu :

A documentation generator for .Net that is not complicated, inconvenient, or difficult to use. Given the assembly and XML generated by Visual Studio, a document can create an entire documentation site with a single command.

---

Third option of NDoc :

NDoc generates class library documentation from .NET collections and XML documentation files generated by the C # compiler (or using an additional tool for VB.NET).

NDoc uses plug-in documenters to create documentation in several different formats, including HTML Help format in MSDN format (.chm), Visual Studio.NET Help format (HTML Help 2), and MSDN web pages on the Internet.

Answer 3

NDoc is also an option. But I would go with a sand castle, and that is exactly what I did.

Answer 4

I created an open source project to expose them in WebPages Check out @ AutoHelp

AutoHelp reads DLL and XML Doc files, creates help pages, and provides them to users. AutoHelp uses ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery and Bootstrap to become a modern web application.