Monday 30 November 2015

Sandcastle an auto C# code documentation tools

Microsoft gave us Sandcastle that is an open source documentation generator tool that reads our assemblies (DLL or EXE files) and their XML Comments and automatically generates HTML documentation.

In this blog will learn :
How to use Sandcastle?
How to comment on c# code for documentation?
How to create html/ documentation website for our code?

Download and install Sandcastle 

Download and install  Sandcastle Help File Builder

Go to
C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderGUI.exe

Create new project

Make changes in configuration like output mode

Add dll,xml in project explorer, documentation sources. build

Build Project

And open help\index file from project.

Video Reference