Make .chm based documenation from xml documentation file using sandcastle tool in c#

How to create Documentation using SandCastle Tool

SandleCastle is one of the best tool tocreate documentation from XML documentation file(Generated by c# compiler)
 Content
  1. What is Sandcastle tool
  2. Install the sandcastle tool
  3. Generate XML documentation of your project
  4. Create New Project In Sandcastle GUI
  5. Add document resource in project 
  6. Build Your sandcastle project
  7. Generated .chm help file for your project

What is Sandlcastle

This is the tool created by Microsoft and freely available on sandcastle.codeplex.com. Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. It generate the .chm file based documentation for you project.

Install the sandcastle tool

First download sandcastle tool from http://sandcastle.codeplex.com/. and Sand Castle help file Builder from shfb.codeplex.com. 
  1. Install the Sandcastle tool
  2. Unzip and SHFBGuidedInstaller_1940 file and click on SandcastleInstaller.exe, It will install the basic component used by sandcastle tool
  3. Go to InstallResources folder with in folder you have extracted. 
  4. Install the SandcastleHelpFileBuilder_1940.msi
  5. It will install the SandCastle help file builder gui tool in C:\Program Files\EWSoftware\Sandcastle Help File Builder
  6. You have now every thing ready

 Generate XML documentation of your project

 Now you need to Generate the xml based documentation for your project
This is very simple, follow the below steps
  1. Right Click on your project select property
  2. Click Build=>Check the XML documentation file
 
  1. Save the project
  2. Build your project, and you will find XML documentation file with in your bin folder.
  3. Close the solution

Create New Project In Sandcastle GUI 

Steps
  1. Go to C:\Program Files\EWSoftware\Sandcastle Help File Builder and click on SandcastleBuilderGUI.exe 
  2. Click on File and then  New Project

  1.  Give your project a name and save it on any  desired location(When you create the new project, it will ask you the name and location to save the project)
  2. You have your project ready.

Add document resource in project 

  1. Right Click on document resource
  2. Click on add document resource
  3. Navigate to your project bin folder(visual studio project's bin folder)
  4. Select your project's dll file and XML file

  1. Click On open and the will add these files under document resource 
  2. Select Projects basic properties like Header and footer text for you .chm help file
  3. Modify the help title, CopyrightText, CopyRightHref, FeedbackEmail Address and there many other properties you can set as your need
     

     Build Your sandcastle project project

  1. Now Press ctrl+shift+B to build your project
  2. It will take little time to build the project.

Generated .chm help file for your project

  1. When it will finished build
  2. You need to navigate to the folder where you  have saved your sandcastle project.
  3. Navigate to help folder
  4. Click on help file
  5. You  have your chm based documentation ready.


? All the best ?

Please don't forget to Recommend this on Google by press +1 Google button below. 
Thanks

Comments

Post a Comment

Popular posts from this blog

Insert, Delete Rows, columns in HTML table Using Javascript

How to insert delete rows and cells dynamically in table using JavaScript Lets create a table object var table=document.CreateElement('table'); Or if you want to modify existing table then use below line. var table=document.getElementById('empTable'); you can set the attributes of table object using following code //Syntax object.setAttribute(attributeName, attributeValue); table.setAttribute("cellpadding","0"); table.setAttribute("cellspacing","0"); Now i want to add new row at the end, table, For this you need to get the Count of rows in table and Add the row at last index. var rows=table.getElementsByTagName('tr'); this will return the rows as array of object. Now insert new row at last index of table var lastIndex=rows.length; var newRow=table.insertRow(lastIndex); Now add the column to the newRow object. var cell=newRow.incertCell(0); Lets say i want to set inner HTML of this cell ...
Read more

Lite PromiseJS(Light weight JavaScript promise library)

lite-promise https://github.com/vijaytanwar/lite-promise Lightest implementation of promise library in JavaScript, Minified version is only 1.5 KB still supporting quote unique features. It execute all promises as fast as possible, and it directly call success or error function when all the promise resolves or rejects without using timers, which make this library superfast. Features Supported by this library when: run more then once function params: holds parameters for functions inside "when" function call. success: called when all promises are resolved error: called when any of the promise rejects cancel: abort the function call and dont call the success or error functions progress: called multiple times when promises are resolved. dynamicPromise: will wrap exiting normal javascript function in promise enabled function and return value from your function will be passed in success call and exception will treated as promise rejected. Create defered functi...
Read more

Open source Social Networking site in Asp.net and Microsoft Ajax

Image
Open source Social Networking site in Asp.net and Microsoft Ajax If you want to develop Facebook like chat application in asp.net then don't go anywhere ChatME is open source best application to start with. Contain lots of functionality like message posting, chat box implementation, automatically loading pages using Ajax, Gallery management, Gallery sharing,  window.location.hash implementation to modify the URL of page without loading the page. There are so many other other advanced technique. Best part is that it is developed by only single developer within 1.5 month only. https://chatme.codeplex.com/ Contact me if you any some issue in setting this project in Visual Studio or setting database. tamarvijay@gmail.com
Read more