XML documentation problem - Visual Studio 2010

Question

3.50/5 (2 votes)

See more:

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

Ognjen2

Updated 29-May-11 5:59am

v2

Add a Solution

Comments

thatraja 29-May-11 11:47am

Include your code in your question.

Sergey Alexandrovich Kryukov 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 29-May-11 12:19pm

Please be more clear while asking question we need more information about your question :)

Sergey Alexandrovich Kryukov 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 29-May-11 12:33pm

please clarify your question with sample code.

Sergey Alexandrovich Kryukov 29-May-11 14:11pm

OP probably got no idea how to make such code. I provided general direction.
Please see my answer.
--SA

Sergey Alexandrovich Kryukov 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

2 solutions

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

Posted 29-May-11 8:10am

Sergey Alexandrovich Kryukov

Comments

Monjurul Habib 29-May-11 18:12pm

i am not sure OP is looking for this or not. anyway my 5 for the great advise.

Sergey Alexandrovich Kryukov 29-May-11 18:44pm

Thank you, Monjurul.
Whatever OP means by "convert to Web page", this method would work anyway.
--SA

thatraja 29-May-11 21:11pm

Agree, My 5.Some OPs never came with their code. :(

Sergey Alexandrovich Kryukov 29-May-11 22:16pm

Thank you, Raja.
--SA

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

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

Valery Possoz · Accepted Answer · 2011-05-29T09:00:00

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[^]

XML documentation problem - Visual Studio 2010

2 solutions

Solution 2

Solution 1

Add your solution here

Preview 0

Existing Members

...or Join us