Sandcastle help file builder is a nice tool to generate a help file our projects. In this blog I will explain, how to simply generate the help files for projects
STEP 1:
Create a new C# class library project and add a simple
method called save() and before the method we put three slash(///), It will automatically
generate a XML comments like
/// <summary>
///
/// </summary>
/// <param
name="id"> </param>
/// <param
name="name"> </param>
public void Save(int id, string name)
{
}
We will add comment for this method like below
/// <summary>
/// this method is used to save the user information’s
/// </summary>
/// <param
name="id">this props holds id of the
user</param>
/// <param
name="name">this props holds name of the
user</param>
public void Save(int id, string name)
{
}
STEP 2:
Go to solution explorer -> right click-> click
properties ->click the build tab
And check the XML documentation file check box shown
into below image(click the image shown in popup for clear visible)
Finally rebuild the solution it will automatically generate
a XML file
STEP 3:
Install the sandcastle Help
File Builder and Tools. Go to the below link download
the tools, install in to your system http://shfb.codeplex.com/ and open the tool
STEP 4:
Go to file menu -> click the new project ->give the
file path and click the save button
The screen look like (click the image shown in popup for clear visible)
Fill the help file name, presentation style, copyright URL,
feedback email address and etc…
Look at the right upper corer we look at the menu project explorer, right click the project explorer and add
project reference( which project we want
generate helper file) and documentation
resource (refer step2).
Finally we go documentation menu and build the projects, it
will generate the Help file like
Awesome help file will be ready ….. Thanks
