473,385 Members | 1,483 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,385 software developers and data experts.

How to generate an HTML from XML documentation tags

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.

Aug 28 '06 #1
4 2037
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.
"Water Cooler v2" <wt*****@yahoo.comwrote in message
news:11**********************@m73g2000cwd.googlegr oups.com...
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.

Aug 28 '06 #2
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

Aug 28 '06 #3

Water Cooler v2 wrote:
Having documented your C# code with the XML tags for documentation, how
do you then generate a HTML help file (.chm) for it?
you look at the "sandcastle" project from microsoft or at ndoc, or some
of the commercially available products..

Aug 28 '06 #4
No problem. The MSDN Library has an excellent reference:

http://msdn.microsoft.com/library/en...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.
"Water Cooler v2" <wt*****@yahoo.comwrote in message
news:11**********************@m73g2000cwd.googlegr oups.com...
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

Aug 28 '06 #5

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

11
by: shank | last post by:
<% Response.contenttype = "application/vnd.ms-excel" %> <% Response.AddHeader "Content-Disposition", "filename=hardware.xls" %> I'm using the above lines to generate a spreadsheet from a...
0
by: Almoni | last post by:
Hi, I have a few .xsd files that include each other in the following way: <!-- lets call the main schema file AA.xsd and it includes BB.xsd inside it --> <xs:schema...
8
by: Marc Rochkind | last post by:
Nearly everything written about HTML falls into one of two categories: 1. Material written for HTML authors, or 2. Material written for user-agent implementors about standard HTML However,...
4
by: Zoltan Hernyak | last post by:
Hi, How can I generate a Windows help file (CHM or HLP) from my C# source code? I commented every class and methods and fields, and generated a DLL, but how can I generate a class...
2
by: Andy Meca | last post by:
I wrote a component library in C#. Is there a tool that will generate documentation for me which looks exactly like the Microsoft .NET framework documentation? I saw a third party component...
82
by: Eric Lindsay | last post by:
I have been trying to get a better understanding of simple HTML, but I am finding conflicting information is very common. Not only that, even in what seemed elementary and without any possibility...
4
by: sysxperts | last post by:
Hi, I have a mail server that generates archives in a directory for every message sent or received and each archive has an associated XML file with <sender>, <receiver>, <subject> and other...
1
by: Carl Johansen | last post by:
Hi all, I have an ASP.NET 2.0 website in Visual Studio 2005 (ie I open it with File | Open Web Site...). I have put XML comments in the source code in the App_Code directory (with <summary>...
15
by: Francach | last post by:
Hi, I'm trying to use the Beautiful Soup package to parse through the "bookmarks.html" file which Firefox exports all your bookmarks into. I've been struggling with the documentation trying to...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.