Monday, March 3, 2014

Help file builder in C Sharp projects using Sandcastle help file builder

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

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)

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
Install the sandcastle Help File Builder and Tools. Go to the below link download the tools, install in to your system  and open the tool
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 (click the image shown in popup for clear visible)

Awesome help file will be ready ….. Thanks

1 comment:

  1. sir ek problem window form me ek project bana raha hu.jisme database access ka h.......problem ye h ki jab me us database me koi nai table banata hu or project run karta hu to ek bar to sahi se run ho jata h...but thodi der bad wo table database me se apne aap remove ho jati h or error aati h table not found.......plz give me a solution ASAP