Sunday, March 30, 2008

creating MSDN-style documentation from .NET assemblies - SandCastle

Introduction: Sandcastle is a command line based tool created by Microsoft, used for creating MSDN-style documentation from .NET assemblies and their associated XML comments files. Sandcastle Help File Builder is to provide graphical and command line based tools to build a help file in an automated fashion.

Simple steps to generate help files for your assemblies 
=====================================

I. Softwares to be installed:
SandCastle - http://www.codeplex.com/Sandcastle
SandCstle help file builder - http://www.codeplex.com/SHFB

II. Configuration in Visual studio
Configure Visual studio to generate XML comment file along with assemblies

Project properties -> Build tab -> check “XML documentation file”

III. Configure SandCastle Help Builder
Create a new project and add your assembly to the project. Once you added assemblyname it appears with xml comment file. It looks like ”MyAssembly.dll, MyAssembly.xml”.

IV. Finally build help file
In SandCastle Help Builder -> Goto “Documentation” menu -> Build Project

Once you build project, It saves help project file as well once it gets build you will have your html help file.

****END**** 

 

Posted by at 15:15:34 | Permalink | No Comments »