Friday, January 28, 2011

Documentation of C# Code with SandCastle and Visual Studio 2010

In this post I'll show you, how you can create a documention of your code. In the past ndoc was the tool to create code docus but the project seems to be dead. Therefore we use SandCastle, a freeware tool, that is also used by Microsoft to create Code-Documentations.

Here is the reference of the comments within visual studio:



First of all you need to install these things in the given order.

Before you can create the code documentation, you have to create the documentation XML in Visual Studio. Therefore open your solution. Open the properties of a project within the solution.

Open Properties

Now in the build tab check the "XML Documentation File". The xml is now generated in the \bin\Debug folder. Of couse you can enter your own path if necessary.



Now rebuild your solution and check if a xml file exists beside the newly created dll.



The next steps are to open the GUI (SandCastel Help File Builder) and create a new project. You should find the gui in your start menu > programs.


I don't want to reinvent the whell therefore, I forward you to some other sites. These sites can explain the next steps certainly better than I can. If you choose the Step by Step Tutorial, you can now start by step 4.

1 comment:

Muhammad Azeem said...

This is a nice article..
Its very easy to understand ..
And this article is using to learn something about it..

c#, dot.net, php tutorial

Thanks a lot..!