Click here to Skip to main content
Rate this: bad
good
Please Sign up or sign in to vote.
Hello,
I've been using /// comments in C#, and when I build it into an XML file, I cannot convert it into a webpage. Can somebody help me?
Posted 29-May-11 5:30am
Ognjen2516
Edited 29-May-11 5:59am
v2
Comments
thatraja at 29-May-11 11:47am
   
Include your code in your question.
SAKryukov at 29-May-11 14:11pm
   
OP probably got no idea how to make such code. I provide general direction.
Please see my answer.
--SA
RaviRanjankr at 29-May-11 12:19pm
   
Please be more clear while asking question we need more information about your question :)
SAKryukov at 29-May-11 14:11pm
   
OP probably got no idea how to make such code. I provide general direction.
Please see my answer.
--SA
Monjurul Habib at 29-May-11 12:33pm
   
please clarify your question with sample code.
SAKryukov at 29-May-11 14:11pm
   
OP probably got no idea how to make such code. I provided general direction.
Please see my answer.
--SA
SAKryukov at 29-May-11 14:00pm
   
This is not a valid question, and the solution should be quite simple. It looks like you have XML files already, as Visual Studio makes them for you. You only need to present it on the form of HTML, with clickable items. Show your processing code and XML and HTML sample, but please don't show real-life samples, make a tiny sample of commented code and show all on this sample.
--SA
Rate this: bad
good
Please Sign up or sign in to vote.

Solution 1

If you haven't done so, I would advise to apply XSLT transformation from Visual Studio generated XML documents to HTML code.
 
This is should be simple enough as there is one-to-one correspondence between items of Visual Studio XML document format and output HTML. XML tags like typeparam, param, return, seealso, etc. should appear on output as HTML anchor tags. Your HTML page should behave like browsing commented reflected code under Visual Studio, when you click on the reference in the Solution Explorer, open the reference and browse it.
 
—SA
  Permalink  
Comments
Monjurul Habib at 29-May-11 18:12pm
   
i am not sure OP is looking for this or not. anyway my 5 for the great advise.
SAKryukov at 29-May-11 18:44pm
   
Thank you, Monjurul.
Whatever OP means by "convert to Web page", this method would work anyway.
--SA
thatraja at 29-May-11 21:11pm
   
Agree, My 5.Some OPs never came with their code. :(
SAKryukov at 29-May-11 22:16pm
   
Thank you, Raja.
--SA
Rate this: bad
good
Please Sign up or sign in to vote.

Solution 2

Hello,
 
There are a few products that will convert the generated visual studio XML comments file into something more human friendly.
 
My favourite is "Sandcastle Help File Builder"
http://shfb.codeplex.com/[^]
 
This is the getting started page:
http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/b772e00e-1705-4062-adb6-774826ce6700.htm[^]
 
Sandcastle projects are compiled by MSBuild so you can integrate them in your solution very easily. You can configure the output to be an MSDN style CHM file or if you prefer a HTML page or even a PDF...
 
It's a really cool product. And it's free!
 
Valery.
PS: Have you looked at GhostDoc for your XML comments?
http://submain.com/products/ghostdoc.aspx[^]
  Permalink  
Comments
SAKryukov at 29-May-11 18:46pm
   
Sounds good, my 5, but my method has the benefit of doing it even on the fly and full flexibility.
Please see my answer.
--SA
valery possoz at 30-May-11 4:44am
   
Thanks. Your solution is nice and simple, I've never done it this way. I'll give it a go ;)
Valery.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)



Advertise | Privacy | Mobile
Web03 | 2.8.141022.2 | Last Updated 29 May 2011
Copyright © CodeProject, 1999-2014
All Rights Reserved. Terms of Service
Layout: fixed | fluid

CodeProject, 503-250 Ferrand Drive Toronto Ontario, M3C 3G8 Canada +1 416-849-8900 x 100