Submit My Question - Recent Questions - Recent Answer
Msdn Tech >> Visual Studio >> Developer Documentation and Help System

Code documentation sample

Hi all,
I wan to make my cutomies documentation of the application code.
I wan to know how I link internet website in the documentation code.

If I use the XML comments, How I create Like MSDN help files.

Regards...

[227 byte] By [Wasim] at [2008-2-2]
«« Webbrowser control - cf .20
»» Comact framework: C#: Index of the sender control to focus next control
# 1
Wasim:
To create help files like MSDN's you will need to create or purchase a tool that can understand the XML comments and add the necessary HTML formatting along with whatever links are necessary to enable navigation of the site. Then you can just post those files on a Web server like you would any other HTML files.

Does that answer your question?

Michael Blome
Visual C# Documentation Manager

MichaelBlome at 2007-9-9 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
# 2

Hello,

First, I'll make sure I understand your scenario. It sounds like you're developing an application and want to ship help documentation with that application. You have Xml comments in your code, and you want to convert that to documentation that looks like MSDN online, right?

Currently we don't offer a feature out of the box that can convert your Xml comments to MSDN-like documentation. There are several 3rd party tools such as NDoc that can help you.

We are looking at improving this scenario for future versions of Visual Studio.

Thanks,
Jeremy Jones

JeremyJones at 2007-9-9 > top of Msdn Tech,Visual Studio,Developer Documentation and Help System...
Visual Studio
Developer Documentation and Help System

Visual Studio Hot Topic

Visual Studio New Topic

Visual Studio

Java / MSDN / Linux Tech / PHP Tech / MSDN DotNet / MSDN TECH / Health Library / Programmers Tech / visual basic Tech / Developer Tech / Ipod faqs / Msdn China Tech

Site Classified