How to generate an HTML from XML documentation tags

  • Thread starter Thread starter Water Cooler v2
  • Start date Start date
W

Water Cooler v2

Having documented your C# code with the XML tags for documentation, how
do you then generate a HTML help file (.chm) for it?

I am talking about code decoration tags such as:

///<summary>
///</summary>

etc.
 
You use an XSL transform to transform the XML comments to HTML. Then you may
compile the result to .chm if you wish.

--
HTH,

Kevin Spencer
Microsoft MVP
Chicken Salad Surgery

It takes a tough man to make a tender chicken salad.
 
Thanks, Kevin. Can you please point me to a good XSL tutorial online?
Google turns up many but I am not sure which one covers:

1. The essentials only, leaving out fluff
2. Does it at a rapid pace
 
Water said:
Having documented your C# code with the XML tags for documentation, how
do you then generate a HTML help file (.chm) for it?
Click to expand...

you look at the "sandcastle" project from microsoft or at ndoc, or some
of the commercially available products..
 
No problem. The MSDN Library has an excellent reference:

http://msdn.microsoft.com/library/e...68-cbbb-4be5-9dd2-40f94488a1cf.asp?frame=true

Also, you may not be aware of the XSL editing tools in Visual Studio 2005
(they are not obvious). When you open an XSL document in Visual Studio 2005,
it opens inthe XSLT Editor. This editor has intellisense that enables you to
see errors immediately, auto-complete, and even debug your XSL with
step-through debugging.

--
HTH,

Kevin Spencer
Microsoft MVP
Chicken Salad Surgery

It takes a tough man to make a tender chicken salad.
 
Back
Top